CIP JavaScript documentation for class " pfcUnitSystem"

Class pfcUnitSystem

Description

This class describes a particular unit system in the model.

Property Summary


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

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

`/* readonly */ pfcUnitSystemType`	`Type`
	Specifies the type of the unit system.

Method Summary


`void`	`Delete ()`
	Delete the unit system

`/* optional */ pfcUnit`	`GetUnit (pfcUnitType Type)`
	Retrieves the unit used by the unit system for a particular type.

Property Detail

/* readonly */ boolean IsStandard

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

string Name

Specifies the name of the unit system

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The unit system cannot be modified because if is standard, or new_name already exists, or the model cannot be modified.

/* readonly */ pfcUnitSystemType Type

Specifies the type of the unit system.

Method Detail

void Delete ()

Delete the unit system

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The unit system cannot be modified because if is standard, or is the principal system, or the model cannot be modified.

/* optional */ pfcUnit GetUnit (pfcUnitType Type)

Retrieves the unit used by the unit system for a particular type.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - system does not contain a unit of the requested type.

Parameters: