Package ptolemy.data.ontologies.lattice.unit

Class UnitConcept

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.data.ontologies.Concept

ptolemy.data.ontologies.InfiniteConcept

ptolemy.data.ontologies.FlatTokenInfiniteConcept

ptolemy.data.ontologies.lattice.unit.UnitConcept

All Implemented Interfaces:

java.lang.Cloneable, InequalityTerm, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

BaseUnitConcept, DerivedUnitConcept

public abstract class UnitConcept
extends FlatTokenInfiniteConcept

The abstract base class for the unitSystem ontology base and derived unit concepts.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

Pt.AcceptedRating:

Red (cshelton)

Pt.ProposedRating:

Red (cshelton)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected ScalarToken	_unitFactor	The multiplication factor for converting this unit to the SI unit for this physical dimension.
protected ScalarToken	_unitOffset	The offset factor for converting this unit to the SI unit for this physical dimension.

Fields inherited from class ptolemy.data.ontologies.FlatTokenInfiniteConcept

_representative, _tokenValue

Fields inherited from class ptolemy.data.ontologies.Concept

isAcceptable

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnitConcept(Ontology ontology, DimensionRepresentativeConcept representative, RecordToken unitInfo)	Create a new BaseUnitConcept, belonging to the given ontology.

Method Summary

Modifier and Type	Method	Description
boolean	canBeConvertedTo(UnitConcept unit)	Return true if this unit can be converted to the specified unit.
DimensionRepresentativeConcept	getDimension()	Return the the dimension concept for this unit concept.
ScalarToken	getUnitFactor()	Return the multiplication factor that converts a value in this unit to the SI unit for this dimension.
java.lang.String	getUnitName()	Return the name of the unit.
ScalarToken	getUnitOffset()	Return the offset factor that converts a value in this unit to the SI unit for this dimension.
java.lang.String	toString()	Return the string representation of this base unit concept.

Methods inherited from class ptolemy.data.ontologies.FlatTokenInfiniteConcept

compare, createFlatTokenInfiniteConcept, equals, getColor, getRepresentative, getTokenValue, greatestLowerBound, hashCode, leastUpperBound

Methods inherited from class ptolemy.data.ontologies.Concept

getAssociatedObject, getOntology, getValue, getVariables, initialize, isAboveOrEqualTo, isSettable, isValueAcceptable, setValue

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setContainer, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, validateSettables, workspace

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Field Detail

_unitFactor

protected ScalarToken _unitFactor

The multiplication factor for converting this unit to the SI unit for this physical dimension.

_unitOffset

protected ScalarToken _unitOffset

The offset factor for converting this unit to the SI unit for this physical dimension.

Constructor Detail

UnitConcept

protected UnitConcept(Ontology ontology,
                      DimensionRepresentativeConcept representative,
                      RecordToken unitInfo)
               throws IllegalActionException,
                      NameDuplicationException

Create a new BaseUnitConcept, belonging to the given ontology.

Parameters:

ontology - The ontology to which this concept belongs.

representative - The finite concept that represents the physical dimension for the set infinite concepts that represent units for this dimension in the ontology lattice.

unitInfo - The record token value that has the name and scale factor information for this unit.

Throws:

NameDuplicationException - Should never be thrown.

IllegalActionException - If the base class throws it.

Method Detail

canBeConvertedTo

public boolean canBeConvertedTo(UnitConcept unit)

Return true if this unit can be converted to the specified unit.

Parameters:

unit - The other unit concept to compare to this one.

Returns:

true if the units can be converted, false otherwise.

getDimension

public DimensionRepresentativeConcept getDimension()

Return the the dimension concept for this unit concept.

Returns:

The dimension concept to which this unit concept belongs.

getUnitFactor

public ScalarToken getUnitFactor()

Return the multiplication factor that converts a value in this unit to the SI unit for this dimension.

Returns:

The unit factor as a scalar token.

getUnitName

public java.lang.String getUnitName()

Return the name of the unit.

Returns:

The name of the unit.

getUnitOffset

public ScalarToken getUnitOffset()

Return the offset factor that converts a value in this unit to the SI unit for this dimension. Currently this is only used for temperature unit conversions.

Returns:

The unit offset as a scalar token.

toString

public java.lang.String toString()

Return the string representation of this base unit concept. It concatenates the name of the representative concept physical dimension name with the name of the unit.

Overrides:

toString in class FlatTokenInfiniteConcept

Returns:

The string representation of this concept.