CIP C++ documentation for class "pfcUnitConversionFactor"

Class pfcUnitConversionFactor

# include <pfcUnits.h> class pfcUnitConversionFactor : public virtual xobject { xdeclare(pfcUnitConversionFactor) ... }; This is a COMPACT class.

Description

This class describes how a unit is related to its reference unit.

Method Summary


`static pfcUnitConversionFactor_ptr`	`Create (xreal Scale)`
	Creates a new unit conversion factor object.

`optional xreal`	`GetOffset ()`
`void`	`SetOffset (optional xreal value)`
	The offset value applied to values in the reference unit.

`xreal`	`GetScale ()`
`void`	`SetScale (xreal value)`
	The scale applied to values in the reference unit to get the value in the actual unit.

Method Detail

`xreal`	`GetScale`	`()`
`void`	`SetScale`	`(xreal value)`

The scale applied to values in the reference unit to get the value in the actual unit.

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

`optional xreal`	`GetOffset`	`()`
`void`	`SetOffset`	`(optional xreal value)`

The offset value applied to values in the reference unit.

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

static pfcUnitConversionFactor_ptr Create (xreal Scale)

Creates a new unit conversion factor object.

Parameters:

Scale: The scale applied to values in the reference unit to get the value in the actual unit.