Units

Units
This container holds the project Unit Systems and unit settings.

Data Entities

Quantity

Holds the unit definition for a specific quantity within a unit system.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
IsSuppressed

True if this quantity is suppressed in the unit system.

Type     bool
Read Only    No
QuantityName

The name of the quantity.

Type     string
Read Only    No
Unit

The unit for the quantity.

Type     string
Read Only    No

UnitSystem

Holds the definition of a unit system within the project.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
IsDefault

True if this is the current default unit system.

Type     bool
Read Only    No
IsProjectUnitSystem

True if this is the current project unit system.

Type     bool
Read Only    No
Quantities

The set of quantity entities that define the unit system.

Type     DataReferenceSet
Read Only    Yes
UnitSystemName

The internal name of the unit system.

Type     string
Read Only    Yes

Methods

Export

Exports unit system information into a Units XML file.

Required Arguments

FilePath    The full path and name of the file to be created.
    Type     string


Release 18.2 - © ANSYS, Inc. All rights reserved.