CIP JAVA documentation for class "com.ptc.pfc.pfcUnits.Unit"

Interface Unit

package com.ptc.pfc.pfcUnits; public interface Unit extends com.ptc.pfc.pfcObject.Child

Description

This class describes a particular unit in the model.

Direct Known Subclasses:: WUnit

Method Summary
`void`	`Delete ()` Delete the unit
`UnitConversionFactor`	`GetConversionFactor ()` Get method for attribute "ConversionFactor" The relationship of the unit to its reference unit.
`String`	`GetExpression ()` Get method for attribute "Expression" 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.
`boolean`	`GetIsStandard ()` Get method for attribute "IsStandard" Whether the unit is system-defined (value `true`) or user-defined (value `false`).
`String`	`GetName ()` Get method for attribute "Name" Specifies the name of the unit.
`Unit`	`GetReferenceUnit ()` Get method for attribute "ReferenceUnit" The reference unit of the unit.
`UnitType`	`GetType ()` Get method for attribute "Type" The type of quantity represented by the unit.
`void`	`Modify (UnitConversionFactor ConversionFactor, Unit ReferenceUnit)` Modify a unit's definition by applying a new conversion factor and reference unit.
`void`	`SetName (String value)` Set method for attribute "Name" Specifies the name of the unit.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Method Detail

GetName/SetName

`String`	`GetName`	`()`
`void`	`SetName`	`(String value)`

Specifies the name of the unit.

Exceptions thrown (but not limited to):

XToolkitCantModify - 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

GetType

UnitType GetType ()

The type of quantity represented by the unit.

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

GetIsStandard

boolean GetIsStandard ()

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

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

GetConversionFactor

UnitConversionFactor GetConversionFactor ()

The relationship of the unit to its reference unit.

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

GetReferenceUnit

Unit GetReferenceUnit ()

The reference unit of the unit.

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

GetExpression

String 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):

XToolkitNotFound - The unit type was not recognized.

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

Modify

void Modify (UnitConversionFactor ConversionFactor, Unit ReferenceUnit)

Modify a unit's definition by applying a new conversion factor and reference unit.

Exceptions thrown (but not limited to):

XToolkitCantModify - 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:

ConversionFactor: The relationship of the unit to its reference unit.
ReferenceUnit: The reference unit.

Returns:

Delete

void Delete ()

Delete the unit

Exceptions thrown (but not limited to):

XToolkitCantModify - The unit referenced from another unit or system of units and cannot be deleted.

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

Returns: