ISTKObject

class ansys.stk.core.stkobjects.ISTKObject

Represents the instance of STK object.

Overview

Methods

export	Export the object to a file.
is_object_coverage_supported	Determine whether or not the object supports ObjectCoverage.
is_access_supported	Determine whether or not the object supports Access.
get_access	Return an Access object associated with this STK object and another STK object specified using its path. The path can be fully-qualified or truncated.
get_access_to_object	Return an Access object associated with this STK object and another STK object.
create_one_point_access	Create one point access to the supplied object name. The Remove method in OnePointAccess should be called when you are done with the data.
unload	Remove the object from the scenario.
supports_analysis_workbench	Return whether the object supports Vector Geometry.
copy_object	Copy and paste the current instance of STK Object. The copied object will be pasted as the sibling of the instance being copied.

Properties

parent	Return the parent object or null if the object has become orphaned. The exception is STKObjectRoot object which is a topmost element and does not have a parent.
path	Return the object path.
instance_name	A name of the object.
class_type	Return a class type of the object (i.e. eAircraft, eFacility etc.).
class_name	Return a class name of the object (i.e. Aircraft, Facility.).
children	Return a collection of direct descendants of the current object.
root	Return the Root object or null.
data_providers	Return the object representing a list of available data providers for the object.
short_description	The short description of the object.
long_description	A long description of the object.
has_children	Return true if the object has direct descendants.
object_coverage	Return an ObjectCoverage object.
access_constraints	Get the constraints imposed on the object.
object_files	Return the list of files that constitute an object.
analysis_workbench_components	Return an instance of Vector Geometry Tool provider.
central_body_name	The object’s central body.
metadata	Get the object’s metadata. Metadata is a collection of keys and their associated values.

Examples

Create a New AdvCAT Object

# Scenario scenario: Scenario object
advCAT = scenario.children.new(STKObjectType.ADVCAT, "MyAdvCAT")

Import detail

from ansys.stk.core.stkobjects import ISTKObject

Property detail

property ISTKObject.parent: ISTKObject

Return the parent object or null if the object has become orphaned. The exception is STKObjectRoot object which is a topmost element and does not have a parent.

property ISTKObject.path: str

Return the object path.

property ISTKObject.instance_name: str

A name of the object.

property ISTKObject.class_type: STKObjectType

Return a class type of the object (i.e. eAircraft, eFacility etc.).

property ISTKObject.class_name: str

Return a class name of the object (i.e. Aircraft, Facility.).

property ISTKObject.children: ISTKObjectCollection

Return a collection of direct descendants of the current object.

property ISTKObject.root: STKObjectRoot

Return the Root object or null.

property ISTKObject.data_providers: DataProviderCollection

Return the object representing a list of available data providers for the object.

property ISTKObject.short_description: str

The short description of the object.

property ISTKObject.long_description: str

A long description of the object.

property ISTKObject.has_children: bool

Return true if the object has direct descendants.

property ISTKObject.object_coverage: ObjectCoverage

Return an ObjectCoverage object.

property ISTKObject.access_constraints: AccessConstraintCollection

Get the constraints imposed on the object.

property ISTKObject.object_files: list

Return the list of files that constitute an object.

property ISTKObject.analysis_workbench_components: IAnalysisWorkbenchComponentProvider

Return an instance of Vector Geometry Tool provider.

property ISTKObject.central_body_name: str

The object’s central body.

property ISTKObject.metadata: KeyValueCollection

Get the object’s metadata. Metadata is a collection of keys and their associated values.

Method detail

ISTKObject.export(self, filename: str) → None

Export the object to a file.

Parameters:

filename : str

Returns:

None

ISTKObject.is_object_coverage_supported(self) → bool

Determine whether or not the object supports ObjectCoverage.

Returns:

bool

ISTKObject.is_access_supported(self) → bool

Determine whether or not the object supports Access.

Returns:

bool

ISTKObject.get_access(self, object_path: str) → Access

Return an Access object associated with this STK object and another STK object specified using its path. The path can be fully-qualified or truncated.

Parameters:

object_path : str

Returns:

Access

ISTKObject.get_access_to_object(self, object: ISTKObject) → Access

Return an Access object associated with this STK object and another STK object.

Parameters:

object : ISTKObject

Returns:

Access

ISTKObject.create_one_point_access(self, path_to_object: str) → OnePointAccess

Create one point access to the supplied object name. The Remove method in OnePointAccess should be called when you are done with the data.

Parameters:

path_to_object : str

Returns:

OnePointAccess

ISTKObject.unload(self) → None

Remove the object from the scenario.

Returns:

None

ISTKObject.supports_analysis_workbench(self) → bool

Return whether the object supports Vector Geometry.

Returns:

bool

ISTKObject.copy_object(self, new_object_name: str) → ISTKObject

Copy and paste the current instance of STK Object. The copied object will be pasted as the sibling of the instance being copied.

Parameters:

new_object_name : str

Returns:

ISTKObject