CIP JavaScript documentation for class " pfcUnit"

Class pfcUnit

Description

This class describes a particular unit in the model.

Property Summary


`/* readonly */ pfcUnitConversionFactor`	`ConversionFactor`
	The relationship of the unit to its reference unit.

`/* readonly */ string`	`Expression`
	The user-friendly unit description: the name (i.e. "ksi") for ordinary units and the expression (i.e. N/m^3) for system-generated units.

`/* readonly */ boolean`	`IsStandard`
	Whether the unit is system-defined (value `true`) or user-defined (value `false`).

`string`	`Name`
	Specifies the name of the unit.

`/* readonly */ pfcUnit`	`ReferenceUnit`
	The reference unit of the unit.

`/* readonly */ pfcUnitType`	`Type`
	The type of quantity represented by the unit.

Method Summary


`void`	`Delete ()`
	Delete the unit

`void`	`Modify (pfcUnitConversionFactor ConversionFactor, pfcUnit ReferenceUnit)`
	Modify a unit's definition by applying a new conversion factor and reference unit.

Property Detail

/* readonly */ pfcUnitConversionFactor ConversionFactor

The relationship of the unit to its reference unit.

/* readonly */ string Expression

The user-friendly unit description: the name (i.e. "ksi") for ordinary units and the expression (i.e. N/m^3) for system-generated units.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The unit type was not recognized.

/* readonly */ boolean IsStandard

Whether the unit is system-defined (value true) or user-defined (value false).

string Name

Specifies the name of the unit.

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The unit is referenced from the principal system of units and cannot be modified.

/* readonly */ pfcUnit ReferenceUnit

The reference unit of the unit.

/* readonly */ pfcUnitType Type

The type of quantity represented by the unit.

Method Detail

void Delete ()

Delete the unit

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The unit referenced from another unit or system of units and cannot be deleted.

void Modify (pfcUnitConversionFactor ConversionFactor, pfcUnit ReferenceUnit)

Modify a unit's definition by applying a new conversion factor and reference unit.

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The unit cannot be modified because it is referenced from the principal system of units or it is referenced from ref_unit.

Parameters: