class Unit
Package: swiss.avm.up.core.generic.unit.javamodel.Unit
Direct Known Subclasses:
class Unit extends NamedResource, AnnotableComment, ATextSourceProperty
Properties
comment
Describes the intent of this Resource.
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
commonCode
StringLiteral[0..1]
conversion
UnitSystemConversion[0..1]
fullName
ATextSource[0..1]
name
The name of this Resource.
StringLiteral[1..1]
symbol
StringLiteral[1..1]
textSource
Contains the full name of the message. Normally used for display on the HMI.
ATextSource[0..N]
Method Summary
getCommonCode
@FUnit
returns the common code of the default unit
Return:
StringLiteral
getFullName
@FUnit
returns the full name of the unit definition
Return:
ATextSource
getId
@BrControllerTreeFunctionSpace
Returns a unique Id for unit, valid inside OPC-UA definition. Declared as FunctionSpace function instead of private function, to have caching support from actifsource, since iteration is required.
Return:
IntegerLiteral
getId
@FUnit
returns the unitId of th default unit
Return:
IntegerLiteral
getIdByPlatform
@FUnit
returns the resulting id (id of the custom unit defined by platform or the default unit)
Parameters:
PlatformConfig
Return:
IntegerLiteral
getName
@FUint
getName
@FUnit
returns the name of the default unit
Return:
StringLiteral
getNameByPlatform
@FUnit
returns the resulting name (name of the custom unit defined by platform or of the default unit)
Parameters:
PlatformConfig
Return:
StringLiteral
getNamespace
@FUnit
returns the namespace of the default unit
Return:
StringLiteral
getNamespaceByPlatform
@FUnit
returns the resulting namespace (namespace of the custom defined by platform unit or of the default unit)
Parameters:
PlatformConfig
Return:
StringLiteral
getTextLists
@TextFunctionSpace
Returns TextList definition dependent of scope.
Return:
List<NativeTextList>