UnitPreferencesDimension

class ansys.stk.core.stkutil.UnitPreferencesDimension

Object that contains info on the Dimension.

Overview

Methods

set_current_unit

Set the Unit for this simple dimension.

Properties

identifier	Return the ID of the dimension.
name	Return the current Dimension’s full name.
available_units	Return collection of Units.
current_unit	Return the current unit for this dimension.

Import detail

from ansys.stk.core.stkutil import UnitPreferencesDimension

Property detail

property UnitPreferencesDimension.identifier: int

Return the ID of the dimension.

property UnitPreferencesDimension.name: str

Return the current Dimension’s full name.

property UnitPreferencesDimension.available_units: UnitPreferencesUnitCollection

Return collection of Units.

property UnitPreferencesDimension.current_unit: UnitPreferencesUnit

Return the current unit for this dimension.

Method detail

UnitPreferencesDimension.set_current_unit(self, unit_abbrv: str) → None

Set the Unit for this simple dimension.

Parameters:

unit_abbrv : str

Returns:

None