ScriptingSegmentCollection#

class ansys.stk.core.stkobjects.astrogator.ScriptingSegmentCollection#

Bases: IRuntimeTypeInfoProvider

Scripting Segment Collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add an object property to the collection.
`remove`	Remove a object property.
`remove_all`	Remove all object properties.
`cut`	Copy the object property into the clipboard and removes the object property from the list.
`paste`	Pastes the object property from the clipboard and inserts into the list.
`insert_copy`	Copy the object property and inserts the copy into the list.
`get_item_by_index`	Retrieve a scripting segment in the collection by index.
`get_item_by_name`	Retrieve a scripting segment in the collection by name.

Properties

`_new_enum`	Allow you to enumerate through the collection.
`count`	Return the size of the collection.
`provide_runtime_type_info`	Return the RuntimeTypeInfo interface to access properties at runtime.

from ansys.stk.core.stkobjects.astrogator import ScriptingSegmentCollection

property ScriptingSegmentCollection._new_enum: EnumeratorProxy#: Allow you to enumerate through the collection.

property ScriptingSegmentCollection.count: int#: Return the size of the collection.

property ScriptingSegmentCollection.provide_runtime_type_info: RuntimeTypeInfo#: Return the RuntimeTypeInfo interface to access properties at runtime.

ScriptingSegmentCollection.item(self, index_or_name: Any) → ScriptingSegment#

Allow you to iterate through the collection.

ScriptingSegmentCollection.add(self, component_name: str) → ScriptingSegment#

Add an object property to the collection.

ScriptingSegmentCollection.remove(self, index_or_name: Any) → None#

Remove a object property.

ScriptingSegmentCollection.remove_all(self) → None#

Remove all object properties.

ScriptingSegmentCollection.cut(self, index_or_name: Any) → None#

Copy the object property into the clipboard and removes the object property from the list.

ScriptingSegmentCollection.paste(self) → ScriptingSegment#

Pastes the object property from the clipboard and inserts into the list.

ScriptingSegmentCollection.insert_copy(self, obj_property: ScriptingSegment) → ScriptingSegment#

Copy the object property and inserts the copy into the list.

ScriptingSegmentCollection.get_item_by_index(self, index: int) → ScriptingSegment#

Retrieve a scripting segment in the collection by index.

ScriptingSegmentCollection.get_item_by_name(self, name: str) → ScriptingSegment#

Retrieve a scripting segment in the collection by name.