ThrusterSetCollection#

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

Thruster Set Collection.

Overview#

item

Iterate through the collection.

add

Add a new thruster.

remove

Remove a specified thruster.

remove_all

Remove all thrusters.

cut

Copy a thruster to the clipboard and removes the thruster from the list.

paste

Pastes a thruster from the clipboard into the list.

insert_copy

Copy a thruster and inserts the copy into the list.

get_item_by_index

Retrieve a thruster from the collection by index.

get_item_by_name

Retrieve a thruster from the collection by name.

_new_enum

A property that allows you to enumerate through the collection.

count

Get the number of thrusters in the set.

Import detail#

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

Property detail#

property ThrusterSetCollection._new_enum: EnumeratorProxy#

A property that allows you to enumerate through the collection.

property ThrusterSetCollection.count: int#

Get the number of thrusters in the set.

Method detail#

ThrusterSetCollection.item(self, index_or_name: Any) Thruster#

Iterate through the collection.

Parameters:

index_or_name : Any

Returns:

Thruster

ThrusterSetCollection.add(self, thruster_name: str) Thruster#

Add a new thruster.

Parameters:

thruster_name : str

Returns:

Thruster

ThrusterSetCollection.remove(self, index_or_name: Any) None#

Remove a specified thruster.

Parameters:

index_or_name : Any

Returns:

None

ThrusterSetCollection.remove_all(self) None#

Remove all thrusters.

Returns:

None

ThrusterSetCollection.cut(self, index_or_name: Any) None#

Copy a thruster to the clipboard and removes the thruster from the list.

Parameters:

index_or_name : Any

Returns:

None

ThrusterSetCollection.paste(self) Thruster#

Pastes a thruster from the clipboard into the list.

Returns:

Thruster

ThrusterSetCollection.insert_copy(self, thruster: Thruster) Thruster#

Copy a thruster and inserts the copy into the list.

Parameters:

thruster : Thruster

Returns:

Thruster

ThrusterSetCollection.get_item_by_index(self, index: int) Thruster#

Retrieve a thruster from the collection by index.

Parameters:

index : int

Returns:

Thruster

ThrusterSetCollection.get_item_by_name(self, name: str) Thruster#

Retrieve a thruster from the collection by name.

Parameters:

name : str

Returns:

Thruster