CIP Visual Basic.NET documentation for interface "IpfcUnitSystem"

Interface IpfcUnitSystem

Description

This class describes a particular unit system in the model.

Property Summary


`Property`	`IsStandard`	`as Boolean`
	Specifies whether the unit system is system-defined (value `true`) or user-defined (value `false`).

`Property`	`Name`	`as String`
	Specifies the name of the unit system

`Property`	`Type`	`as IpfcUnitSystemType`
	Specifies the type of the unit system.

Method Summary


`Sub`	`Delete ()`
	Delete the unit system

`Function`	`GetUnit (Type as IpfcUnitType) as IpfcUnit [optional]`
	Retrieves the unit used by the unit system for a particular type.

Property Detail

Property IsStandard as Boolean

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

Property Name as String

Specifies the name of the unit system

Exceptions thrown (but not limited to):

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

Property Type as IpfcUnitSystemType

Specifies the type of the unit system.

Method Detail

Sub Delete ()

Delete the unit system

Exceptions thrown (but not limited to):

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

Function GetUnit (Type as IpfcUnitType) as IpfcUnit [optional]

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

Exceptions thrown (but not limited to):

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

Parameters: