IUnitSettings¶

class IUnitSettings¶

Bases: ImpactCOMWrapperBase

Summary:: Specifies formatting options for units.
Remarks:: Introduced in Impact 5.1.4.21.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property angle_decimals¶

Gets angle_decimals.

Summary:: Gets and sets the number of decimal places for angles.

Returns:: The value of angle_decimals.
Return type:: angle_decimals (int)

property angle_denominator¶

Gets angle_denominator.

Summary:: Gets and sets the denominator for angles.

Returns:: The value of angle_denominator.
Return type:: angle_denominator (int)

property angle_fractions¶

Gets angle_fractions.

Summary:: Gets and sets if angles display fractions.

Returns:: The value of angle_fractions.
Return type:: angle_fractions (bool)

property angle_reduce_fraction¶

Gets angle_reduce_fraction.

Summary:: Gets and sets if fractions in angles are reduced, e.g. 32/64 becomes 1/2.

Returns:: The value of angle_reduce_fraction.
Return type:: angle_reduce_fraction (bool)

property angle_suffix¶

Gets angle_suffix.

Summary:: Gets and sets the suffix for angles.

Returns:: The value of angle_suffix.
Return type:: angle_suffix (str)

property angle_type¶

Gets angle_type.

Summary:: Gets and sets the units for angles. Changing angle_type will also cause angle_suffix to change.

Returns:: The value of angle_type.
Return type:: angle_type (ipAngleFormat)

property area_suffix¶

Gets area_suffix.

Summary:: Gets and sets the suffix for areas.
Remarks:: Introduced in Impact 9.0.0.66.

Returns:: The value of area_suffix.
Return type:: area_suffix (str)

property distance_decimals¶

Gets distance_decimals.

Summary:: Gets and sets the number of decimal places for distances.

Returns:: The value of distance_decimals.
Return type:: distance_decimals (int)

property distance_denominator¶

Gets distance_denominator.

Summary:: Gets and sets the denominator for distances.

Returns:: The value of distance_denominator.
Return type:: distance_denominator (int)

property distance_fractions¶

Gets distance_fractions.

Summary:: Gets and sets if distances display fractions.

Returns:: The value of distance_fractions.
Return type:: distance_fractions (bool)

property distance_reduce_fraction¶

Gets distance_reduce_fraction.

Summary:: Gets and sets if fractions in distances are reduced, e.g. 32/64 becomes 1/2.

Returns:: The value of distance_reduce_fraction.
Return type:: distance_reduce_fraction (bool)

property distance_suffix¶

Gets distance_suffix.

Summary:: Gets and sets the suffix for distances.

Returns:: The value of distance_suffix.
Return type:: distance_suffix (str)

property distance_type¶

Gets distance_type.

Summary:: Gets and sets the units for distances. Changing distance_type will also cause distance_suffix to change.

Returns:: The value of distance_type.
Return type:: distance_type (ipDistanceFormat)

property double_decimals¶

Gets double_decimals.

Summary:: The number of decimal places when outputting doubles to strings
Remarks:: Introduced in Impact 11.0.0.27

Returns:: The value of double_decimals.
Return type:: double_decimals (int)

property language¶

Gets Language.

Summary:: A language to use when formatting values
Remarks:: Introduced in Impact 11.0.0.27

Returns:: The value of Language.
Return type:: language (ILanguage)

property locale¶

Gets Locale.

Summary:: A Windows locale name or abbreviation to use when formatting values
Remarks:: For example, use “en” for English, “en-GB” for British English, “de” or “de-DE” for German. Introduced in Impact 11.0.0.27

Returns:: The value of Locale.
Return type:: locale (str)

Examples:

Conversion with unit settings

property volume_suffix¶

Gets volume_suffix.

Summary:: Gets and sets the suffix for volumes.
Remarks:: Introduced in Impact 9.0.0.66.

Returns:: The value of volume_suffix.
Return type:: volume_suffix (str)

property weight_decimals¶

Gets weight_decimals.

Summary:: Gets and sets the number of decimal places for weights.

Returns:: The value of weight_decimals.
Return type:: weight_decimals (int)

property weight_denominator¶

Gets weight_denominator.

Summary:: Gets and sets the denominator for weights.

Returns:: The value of weight_denominator.
Return type:: weight_denominator (int)

property weight_fractions¶

Gets weight_fractions.

Summary:: Gets and sets if weights display fractions.

Returns:: The value of weight_fractions.
Return type:: weight_fractions (bool)

property weight_reduce_fraction¶

Gets weight_reduce_fraction.

Summary:: Gets and sets if fractions in weights are reduced, for example 32/64 becomes 1/2.

Returns:: The value of weight_reduce_fraction.
Return type:: weight_reduce_fraction (bool)

property weight_suffix¶

Gets weight_suffix.

Summary:: Gets and sets the suffix for weights.

Returns:: The value of weight_suffix.
Return type:: weight_suffix (str)

property weight_type¶

Gets weight_type.

Summary:: Gets and sets the units for weights. Changing weight_type will also cause weight_suffix to change.

Returns:: The value of weight_type.
Return type:: weight_type (ipWeightFormat)

isNone()¶: Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

Examples

Conversion with unit settings