LinkToObject

class ansys.stk.core.stkobjects.LinkToObject

Class defining a link to an STK object.

Overview

Methods

bind_to_object

Binds to existing object instance using the specified object path.

Properties

name	Return a name of linked object.
linked_object	Dereferences the link and returns the linked object.
available_objects	Return a list of available objects that can be linked to.
is_intrinsic	Return true if the link references an intrinsic object, otherwise returns false.

Import detail

from ansys.stk.core.stkobjects import LinkToObject

Property detail

property LinkToObject.name: str

Return a name of linked object.

property LinkToObject.linked_object: ISTKObject

Dereferences the link and returns the linked object.

property LinkToObject.available_objects: list

Return a list of available objects that can be linked to.

property LinkToObject.is_intrinsic: bool

Return true if the link references an intrinsic object, otherwise returns false.

Method detail

LinkToObject.bind_to_object(self, path: str) → ISTKObject

Binds to existing object instance using the specified object path.

Parameters:

path : str

Returns:

ISTKObject