VectorGeometryToolSystemGroup#

class ansys.stk.core.analysis_workbench.VectorGeometryToolSystemGroup#: Access or create VGT systems associated with an object or a central body.

Overview#

Methods

`remove`	Remove a specified System.
`contains`	Search for a an element with a given name. Returns false if the specified element does not exist.
`item`	Return a System by name or at a specified position.
`get_item_by_index`	Retrieve a system from the collection by index.
`get_item_by_name`	Retrieve a system from the collection by name.

Properties

`context`	Return a context object. The context can be used to find out which central body or STK object this instance is associated with.
`count`	Return a number of elements in the collection.
`factory`	Return a Factory object used to create custom VGT systems.
`_new_enum`	Return a COM enumerator.
`common_tasks`	Provide access to common tasks that allow users quickly carry out tasks such as creating known systems, etc.

from ansys.stk.core.analysis_workbench import VectorGeometryToolSystemGroup

property VectorGeometryToolSystemGroup.context: IAnalysisWorkbenchComponentContext#: Return a context object. The context can be used to find out which central body or STK object this instance is associated with.

property VectorGeometryToolSystemGroup.count: int#: Return a number of elements in the collection.

property VectorGeometryToolSystemGroup.factory: VectorGeometryToolSystemFactory#: Return a Factory object used to create custom VGT systems.

property VectorGeometryToolSystemGroup._new_enum: EnumeratorProxy#: Return a COM enumerator.

property VectorGeometryToolSystemGroup.common_tasks: VectorGeometryToolSystemCommonTasks#: Provide access to common tasks that allow users quickly carry out tasks such as creating known systems, etc.

VectorGeometryToolSystemGroup.remove(self, system_name: str) → None#

Remove a specified System.

VectorGeometryToolSystemGroup.contains(self, name: str) → bool#

Search for a an element with a given name. Returns false if the specified element does not exist.

VectorGeometryToolSystemGroup.item(self, index_or_name: Any) → IVectorGeometryToolSystem#

Return a System by name or at a specified position.

VectorGeometryToolSystemGroup.get_item_by_index(self, index: int) → IVectorGeometryToolSystem#

Retrieve a system from the collection by index.

VectorGeometryToolSystemGroup.get_item_by_name(self, name: str) → IVectorGeometryToolSystem#

Retrieve a system from the collection by name.