UnitPreferencesDimensionCollection

class ansys.stk.core.stkutil.UnitPreferencesDimensionCollection

Object that contains a collection of dimensions.

Overview

Methods

item	Return an UnitPreferencesDimension given a Dimension name or an index.
set_current_unit	Return the Current unit for a Dimension.
get_current_unit_abbrv	Return the Current Unit for a Dimension.
reset_units	Reset the unitpreferences to the Default units.
get_item_by_index	Retrieve a dimension from the collection by index.
get_item_by_name	Retrieve a dimension from the collection by name.

Properties

count	Return the number of items in the collection.
mission_elapsed_time	The MissionElapsedTime.
julian_date_offset	The JulianDateOffset.
_new_enum	Return a collection of UnitPreferencesDimension.

Import detail

from ansys.stk.core.stkutil import UnitPreferencesDimensionCollection

Property detail

property UnitPreferencesDimensionCollection.count: int

Return the number of items in the collection.

property UnitPreferencesDimensionCollection.mission_elapsed_time: Any

The MissionElapsedTime.

property UnitPreferencesDimensionCollection.julian_date_offset: float

The JulianDateOffset.

property UnitPreferencesDimensionCollection._new_enum: EnumeratorProxy

Return a collection of UnitPreferencesDimension.

Method detail

UnitPreferencesDimensionCollection.item(self, index_or_name: Any) → UnitPreferencesDimension

Return an UnitPreferencesDimension given a Dimension name or an index.

Parameters:

index_or_name : Any

Returns:

UnitPreferencesDimension

UnitPreferencesDimensionCollection.set_current_unit(self, dimension: str, unit_abbrv: str) → None

Return the Current unit for a Dimension.

Parameters:

dimension : str

unit_abbrv : str

Returns:

None

UnitPreferencesDimensionCollection.get_current_unit_abbrv(self, index_or_dim_name: Any) → str

Return the Current Unit for a Dimension.

Parameters:

index_or_dim_name : Any

Returns:

str

UnitPreferencesDimensionCollection.reset_units(self) → None

Reset the unitpreferences to the Default units.

Returns:

None

UnitPreferencesDimensionCollection.get_item_by_index(self, index: int) → UnitPreferencesDimension

Retrieve a dimension from the collection by index.

Parameters:

index : int

Returns:

UnitPreferencesDimension

UnitPreferencesDimensionCollection.get_item_by_name(self, name: str) → UnitPreferencesDimension

Retrieve a dimension from the collection by name.

Parameters:

name : str

Returns:

UnitPreferencesDimension