Library | PackageFrames | Expand Java Toolkit

Interface UnitSystem

package com.ptc.pfc.pfcUnits;

public interface UnitSystem
  extends com.ptc.pfc.pfcObject.Child


Description

This class describes a particular unit system in the model.


Method Summary
voidDelete ()
    Delete the unit system
booleanGetIsStandard ()
    Get method for attribute "IsStandard"
    Specifies whether the unit system is system-defined (value true) or user-defined (value false).
StringGetName ()
    Get method for attribute "Name"
    Specifies the name of the unit system
UnitSystemTypeGetType ()
    Get method for attribute "Type"
    Specifies the type of the unit system.
/*optional*/ UnitGetUnit (UnitType Type)
    Retrieves the unit used by the unit system for a particular type.
voidSetName (String value)
    Set method for attribute "Name"
    Specifies the name of the unit system

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

Method Detail

GetName/SetName

StringGetName ()
voidSetName (String value)


    Specifies the name of the unit system

Exceptions thrown (but not limited to):

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


GetType

UnitSystemTypeGetType ()


    Specifies the type of the unit system.
Manual References:
Solid: Accessing Systems of Units, Solid: Accessing Systems of Units


GetIsStandard

booleanGetIsStandard ()


    Specifies whether the unit system is system-defined (value true) or user-defined (value false).
Manual References:
Solid: Accessing Systems of Units


GetUnit

/*optional*/ UnitGetUnit (UnitType Type)


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

Exceptions thrown (but not limited to):

XToolkitNotFound - 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.

Delete

voidDelete ()


    Delete the unit system

Exceptions thrown (but not limited to):

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