DesignCR3BPObjectCollection

class ansys.stk.core.stkobjects.astrogator.DesignCR3BPObjectCollection

CR3BP associated object Collection.

Overview

Methods

item	Iterate through the collection.
get_item_by_index	Retrieve an associated object from the collection by index.
get_item_by_name	Retrieve an associated object from the collection by name.

Properties

_new_enum	A property that allows you to enumerate through the collection.
count	Get the number of associated objects in the set.

Import detail

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

Property detail

property DesignCR3BPObjectCollection._new_enum: EnumeratorProxy

A property that allows you to enumerate through the collection.

property DesignCR3BPObjectCollection.count: int

Get the number of associated objects in the set.

Method detail

DesignCR3BPObjectCollection.item(self, index_or_name: Any) → DesignCR3BPObject

Iterate through the collection.

Parameters:

index_or_name : Any

Returns:

DesignCR3BPObject

DesignCR3BPObjectCollection.get_item_by_index(self, index: int) → DesignCR3BPObject

Retrieve an associated object from the collection by index.

Parameters:

index : int

Returns:

DesignCR3BPObject

DesignCR3BPObjectCollection.get_item_by_name(self, name: str) → DesignCR3BPObject

Retrieve an associated object from the collection by name.

Parameters:

name : str

Returns:

DesignCR3BPObject