CentralBodyTerrainCollection#

class ansys.stk.core.stkobjects.CentralBodyTerrainCollection#

Represents a collection of terrains associated with central bodies. This collection enables adding terrain to any central bodies and not just to the current scenario’s central body.

Overview#

item

Given an index or a name of a central body, returns an element in the collection.

get_item_by_index

Retrieve a central body terrain from the collection by index.

get_item_by_name

Retrieve a central body terrain from the collection by name.

count

Return the number of elements in a collection.

_new_enum

Return an enumerator that can iterate through the collection.

total_cache_size

Total cache size (not individual terrain sources) for the analytical terrain in the scenario. Dimensionless.

Import detail#

from ansys.stk.core.stkobjects import CentralBodyTerrainCollection

Property detail#

property CentralBodyTerrainCollection.count: int#

Return the number of elements in a collection.

property CentralBodyTerrainCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

property CentralBodyTerrainCollection.total_cache_size: int#

Total cache size (not individual terrain sources) for the analytical terrain in the scenario. Dimensionless.

Method detail#

CentralBodyTerrainCollection.item(self, index: Any) CentralBodyTerrainCollectionElement#

Given an index or a name of a central body, returns an element in the collection.

Parameters:

index : Any

Returns:

CentralBodyTerrainCollectionElement

CentralBodyTerrainCollection.get_item_by_index(self, index: int) CentralBodyTerrainCollectionElement#

Retrieve a central body terrain from the collection by index.

Parameters:

index : int

Returns:

CentralBodyTerrainCollectionElement

CentralBodyTerrainCollection.get_item_by_name(self, name: str) CentralBodyTerrainCollectionElement#

Retrieve a central body terrain from the collection by name.

Parameters:

name : str

Returns:

CentralBodyTerrainCollectionElement