SpatialAnalysisToolVolumeGridGroup

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolVolumeGridGroup

Access or create VGT volume grids associated with an object or a central body.

Overview

Methods

remove	Remove a specified element.
contains	Search for a an element with a given name. Returns false if the specified element does not exist.
item	Return an element by name or at a specified position.
get_item_by_index	Retrieve a volume grid from the collection by index.
get_item_by_name	Retrieve a volume grid 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 group.
factory	Return a factory object used to create volume grid components.
_new_enum	Return a COM enumerator.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolVolumeGridGroup

Property detail

property SpatialAnalysisToolVolumeGridGroup.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 SpatialAnalysisToolVolumeGridGroup.count: int

Return a number of elements in the group.

property SpatialAnalysisToolVolumeGridGroup.factory: SpatialAnalysisToolVolumeGridFactory

Return a factory object used to create volume grid components.

property SpatialAnalysisToolVolumeGridGroup._new_enum: EnumeratorProxy

Return a COM enumerator.

Method detail

SpatialAnalysisToolVolumeGridGroup.remove(self, event_name: str) → None

Remove a specified element.

Parameters:

event_name : str

Returns:

None

SpatialAnalysisToolVolumeGridGroup.contains(self, name: str) → bool

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

Parameters:

name : str

Returns:

bool

SpatialAnalysisToolVolumeGridGroup.item(self, index_or_name: Any) → ISpatialAnalysisToolVolumeGrid

Return an element by name or at a specified position.

Parameters:

index_or_name : Any

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridGroup.get_item_by_index(self, index: int) → ISpatialAnalysisToolVolumeGrid

Retrieve a volume grid from the collection by index.

Parameters:

index : int

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridGroup.get_item_by_name(self, name: str) → ISpatialAnalysisToolVolumeGrid

Retrieve a volume grid from the collection by name.

Parameters:

name : str

Returns:

ISpatialAnalysisToolVolumeGrid