CIP C++ documentation for class "pfcUnit"

Class pfcUnit

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

Description

This class describes a particular unit in the model.

Manual References:: Solid: Solid Units, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`void`	`Delete ()`
	Delete the unit

`pfcUnitConversionFactor_ptr`	`GetConversionFactor ()`
	The relationship of the unit to its reference unit.

`xstring`	`GetExpression ()`
	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.

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

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

`pfcUnit_ptr`	`GetReferenceUnit ()`
	The reference unit of the unit.

`pfcUnitType`	`GetType ()`
	The type of quantity represented by the unit.

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

Method Detail

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

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.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units, Solid: Modifying Individual Units, Solid: Modifying Individual Units

pfcUnitType GetType ()

The type of quantity represented by the unit.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

xbool GetIsStandard ()

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

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

pfcUnitConversionFactor_ptr GetConversionFactor ()

The relationship of the unit to its reference unit.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

pfcUnit_ptr GetReferenceUnit ()

The reference unit of the unit.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

xstring GetExpression ()

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.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

void Modify (pfcUnitConversionFactor_ptr ConversionFactor, pfcUnit_ptr 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.

Manual References:: Solid: Modifying Individual Units, Solid: Modifying Individual Units

Parameters:

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.

Manual References:: Solid: Modifying Individual Units, Solid: Modifying Individual Units