Package ptolemy.data.ontologies.lattice.unit

Class UnitConversionInfo

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.data.expr.Variable

ptolemy.data.expr.Parameter

ptolemy.data.ontologies.lattice.unit.UnitConversionInfo

All Implemented Interfaces:

java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable, ValueListener

Direct Known Subclasses:

SIPrefixUnitConversionInfo

public class UnitConversionInfo
extends Parameter

A parameter that holds a record describing unit conversion information for a UnitConcept in a unit system ontology. A DimensionRepresentativeConcept uses the record token contained in this parameter to generate a particular UnitConcept in its dimension.

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.data.expr.Variable

Variable.CircularDependencyError, Variable.VariableScope

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	unitFactorLabel	The factor label for the unit record token information when constructing a new UnitConcept.
static java.lang.String	unitNameLabel	The name label for the unit record token information when constructing a new UnitConcept.
static java.lang.String	unitOffsetLabel	The offset label for the unit record token information when constructing a new UnitConcept.

Fields inherited from class ptolemy.data.expr.Variable

_currentExpression, _needsEvaluation, _parserScope, _parseTreeValid, _suppressVariableSubstitution, _valueListeners

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

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor	Description
UnitConversionInfo(DimensionRepresentativeConcept container, java.lang.String name)	Create a new UnitConversionInfo parameter with the given name and container.

Method Summary

Modifier and Type	Method	Description
void	setContainer(NamedObj container)	Override the setContainer method to only allow a UnitConversionInfo parameter to be contained by DimensionRepresentativeConcepts.

Methods inherited from class ptolemy.data.expr.Parameter

addChoice, clone, exportMoML, getChoices, removeAllChoices, removeChoice

Methods inherited from class ptolemy.data.expr.Variable

_description, _evaluate, _getCurrentExpression, _notifyValueListeners, _parseIfNecessary, _propagate, _propagateToValueListeners, _propagateValue, _setToken, _setTokenAndNotify, addValueListener, attributeChanged, getDeclaredType, getExpression, getFreeIdentifiers, getParserScope, getScope, getScope, getToken, getType, getTypeTerm, getValueAsString, getVariable, getVisibility, invalidate, isKnown, isLazy, isStringMode, isSuppressVariableSubstitution, isTypeAcceptable, removeValueListener, reset, setExpression, setLazy, setName, setParseTreeEvaluator, setStringMode, setSuppressVariableSubstitution, setToken, setToken, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, setUnknown, setValueListenerAsWeakDependency, setVisibility, stringRepresentation, toString, typeConstraintList, typeConstraints, validate, valueChanged

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getDefaultExpression

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Field Detail

unitNameLabel

public static final java.lang.String unitNameLabel

The name label for the unit record token information when constructing a new UnitConcept.

See Also:

Constant Field Values

unitFactorLabel

public static final java.lang.String unitFactorLabel

The factor label for the unit record token information when constructing a new UnitConcept.

See Also:

Constant Field Values

unitOffsetLabel

public static final java.lang.String unitOffsetLabel

The offset label for the unit record token information when constructing a new UnitConcept.

See Also:

Constant Field Values

Constructor Detail

UnitConversionInfo

public UnitConversionInfo(DimensionRepresentativeConcept container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException

Create a new UnitConversionInfo parameter with the given name and container.

Parameters:

container - The DimensionRepresentativeConcept that contains this parameter.

name - The name of the parameter.

Throws:

IllegalActionException - Thrown if there is a problem creating the parameter.

NameDuplicationException - Thrown if there is already a NamedObj in the DimensionRepresentativeConcept container with the same name.

Method Detail

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

Override the setContainer method to only allow a UnitConversionInfo parameter to be contained by DimensionRepresentativeConcepts.

Overrides:

setContainer in class Variable

Parameters:

container - The new container for this parameter, which must either be a DimensionRepresentativeConcept or null.

Throws:

IllegalActionException - Thrown if the new container is not a DimensionRepresentativeConcept.

NameDuplicationException - Thrown if there is already a NamedObj in the DimensionRepresentativeConcept container with the same name.

See Also:

Attribute.getContainer()