CIP C++ documentation for class "pfcUnitSystem"

Class pfcUnitSystem

# include <pfcUnits.h> class pfcUnitSystem : public virtual pfcChild { xaideclare(pfcUnitSystem) ... };

Description

This class describes a particular unit system in the model.

Manual References:: Solid: Types of Unit Systems

Method Summary


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

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

`xstring`	`GetName ()`
`void`	`SetName (xrstring value)`
	Specifies the name of the unit system

`pfcUnitSystemType`	`GetType ()`
	Specifies the type of the unit system.

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

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Method Detail

`xstring`	`GetName`	`()`
`void`	`SetName`	`(xrstring value)`

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.

Manual References:: Solid: Accessing Systems of Units, Solid: Accessing Systems of Units, Solid: Modifying Systems of Units

pfcUnitSystemType GetType ()

Specifies the type of the unit system.

Manual References:: Solid: Accessing Systems of Units, Solid: Accessing Systems of Units

xbool GetIsStandard ()

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

Manual References:: Solid: Accessing Systems of Units

optional pfcUnit_ptr 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.

Manual References:: Solid: Accessing Systems of Units, Solid: Accessing Systems of Units

Parameters:

Type: The type of unit.

Returns:: The unit.

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.

Manual References:: Solid: Modifying Systems of Units, Solid: Modifying Systems of Units

Returns: