ScriptingCalculationObjectCollection#
- class ansys.stk.core.stkobjects.astrogator.ScriptingCalculationObjectCollection#
Calc Object Collection.
Overview#
Allow you to iterate through the collection. |
|
Add a calculation object to the collection. |
|
Remove a calculation object. |
|
Remove all calculation objects. |
|
Copy the calc object into the clipboard and removes the calc object from the list. |
|
Pastes the calc object from the clipboard and inserts into the list. |
|
Copy the calc object and inserts the copy into the list. |
|
Retrieve a scripting calc object from the collection by index. |
|
Retrieve a scripting calc object from the collection by name. |
Import detail#
from ansys.stk.core.stkobjects.astrogator import ScriptingCalculationObjectCollection
Property detail#
- property ScriptingCalculationObjectCollection._new_enum: EnumeratorProxy#
Allow you to enumerate through the collection.
Method detail#
- ScriptingCalculationObjectCollection.item(self, index_or_name: Any) ScriptingCalculationObject #
Allow you to iterate through the collection.
- Parameters:
index_or_name :
Any
- Returns:
ScriptingCalculationObject
- ScriptingCalculationObjectCollection.add(self, component_name: str) ScriptingCalculationObject #
Add a calculation object to the collection.
- Parameters:
component_name :
str
- Returns:
ScriptingCalculationObject
- ScriptingCalculationObjectCollection.remove(self, index_or_name: Any) None #
Remove a calculation object.
- ScriptingCalculationObjectCollection.remove_all(self) None #
Remove all calculation objects.
- Returns:
- ScriptingCalculationObjectCollection.cut(self, index_or_name: Any) None #
Copy the calc object into the clipboard and removes the calc object from the list.
- ScriptingCalculationObjectCollection.paste(self) ScriptingCalculationObject #
Pastes the calc object from the clipboard and inserts into the list.
- Returns:
ScriptingCalculationObject
- ScriptingCalculationObjectCollection.insert_copy(self, calc_obj: ScriptingCalculationObject) ScriptingCalculationObject #
Copy the calc object and inserts the copy into the list.
- Parameters:
calc_obj :
ScriptingCalculationObject
- Returns:
ScriptingCalculationObject
- ScriptingCalculationObjectCollection.get_item_by_index(self, index: int) ScriptingCalculationObject #
Retrieve a scripting calc object from the collection by index.
- Parameters:
index :
int
- Returns:
ScriptingCalculationObject
- ScriptingCalculationObjectCollection.get_item_by_name(self, component_name: str) ScriptingCalculationObject #
Retrieve a scripting calc object from the collection by name.
- Parameters:
component_name :
str
- Returns:
ScriptingCalculationObject