CIP JavaScript documentation for class " pfcUnitConversionOptions"

Class pfcUnitConversionOptions

Description

This class describes changing the principal unit system of a model.

Property Summary


`pfcUnitDimensionConversion`	`DimensionOption`
	How the dimensions of the model should be converted.

`/* optional */ boolean`	`IgnoreParamUnits`
	This boolean specifies whether to (or not to) ignore parameter units. If `null` or `true` parameter values and units will not be changed when changing the model unit system. If `false`, parameter units will be converted according to the rule specified for dimensions.

Method Summary


`static pfcUnitConversionOptions`	`Create (pfcUnitDimensionConversion DimensionOption)`
	Creates a new unit conversion options object.

Property Detail

pfcUnitDimensionConversion DimensionOption

How the dimensions of the model should be converted.

/* optional */ boolean IgnoreParamUnits

This boolean specifies whether to (or not to) ignore parameter units. If null or true parameter values and units will not be changed when changing the model unit system. If false, parameter units will be converted according to the rule specified for dimensions.

Method Detail

static pfcUnitConversionOptions Create (pfcUnitDimensionConversion DimensionOption)

Creates a new unit conversion options object.

Parameters:

DimensionOption: How the dimensions of the model should be converted.

Returns:: The new object.