TargeterGraphCollection#

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

Bases: IRuntimeTypeInfoProvider

Targeter Graphs.

Overview#

item

Allow you to iterate through the collection.

add_graph

Add a new targeter graph.

remove_graph

Remove a targeter graph.

cut

Copy a targeter graph to the clipboard and removes the targeter graph from the list.

paste

Pastes a targeter graph from the clipboard into the list.

insert_copy

Copy a targeter graph and inserts the copy into the list.

get_item_by_index

Retrieve a targeter graph from the collection by index.

get_item_by_name

Retrieve a targeter graph from the collection by name.

_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.

Import detail#

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

Property detail#

property TargeterGraphCollection._new_enum: EnumeratorProxy#

Allow you to enumerate through the collection.

property TargeterGraphCollection.count: int#

Return the size of the collection.

property TargeterGraphCollection.provide_runtime_type_info: RuntimeTypeInfo#

Return the RuntimeTypeInfo interface to access properties at runtime.

Method detail#

TargeterGraphCollection.item(self, index_or_name: Any) TargeterGraph#

Allow you to iterate through the collection.

Parameters:

index_or_name : Any

Returns:

TargeterGraph

TargeterGraphCollection.add_graph(self) TargeterGraph#

Add a new targeter graph.

Returns:

TargeterGraph

TargeterGraphCollection.remove_graph(self, index_or_name: Any) None#

Remove a targeter graph.

Parameters:

index_or_name : Any

Returns:

None

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

Copy a targeter graph to the clipboard and removes the targeter graph from the list.

Parameters:

index_or_name : Any

Returns:

None

TargeterGraphCollection.paste(self) TargeterGraph#

Pastes a targeter graph from the clipboard into the list.

Returns:

TargeterGraph

TargeterGraphCollection.insert_copy(self, graph: TargeterGraph) TargeterGraph#

Copy a targeter graph and inserts the copy into the list.

Parameters:

graph : TargeterGraph

Returns:

TargeterGraph

TargeterGraphCollection.get_item_by_index(self, index: int) TargeterGraph#

Retrieve a targeter graph from the collection by index.

Parameters:

index : int

Returns:

TargeterGraph

TargeterGraphCollection.get_item_by_name(self, name: str) TargeterGraph#

Retrieve a targeter graph from the collection by name.

Parameters:

name : str

Returns:

TargeterGraph