AnalysisWorkbenchCentralBodyCollection

class ansys.stk.core.analysis_workbench.AnalysisWorkbenchCentralBodyCollection

A collection of central body names.

Overview

Methods

item	Return a central body name at a specified index.
add	Add a central body to the collection of central bodies. True indicates success.
remove	Remove a central body with the specified name from the collection of the central bodies.

Properties

count	Return a number of elements in the collection.
_new_enum	Return a COM enumerator.

Import detail

from ansys.stk.core.analysis_workbench import AnalysisWorkbenchCentralBodyCollection

Property detail

property AnalysisWorkbenchCentralBodyCollection.count: int

Return a number of elements in the collection.

property AnalysisWorkbenchCentralBodyCollection._new_enum: EnumeratorProxy

Return a COM enumerator.

Method detail

AnalysisWorkbenchCentralBodyCollection.item(self, index: int) → str

Return a central body name at a specified index.

Parameters:

index : int

Returns:

str

AnalysisWorkbenchCentralBodyCollection.add(self, central_body_name: str) → bool

Add a central body to the collection of central bodies. True indicates success.

Parameters:

central_body_name : str

Returns:

bool

AnalysisWorkbenchCentralBodyCollection.remove(self, central_body_name: str) → None

Remove a central body with the specified name from the collection of the central bodies.

Parameters:

central_body_name : str

Returns:

None