ptolemy.data.ontologies.lattice.unit

Class BaseDimensionRepresentativeConcept

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.data.ontologies.Concept

ptolemy.data.ontologies.FiniteConcept

ptolemy.data.ontologies.InfiniteConceptRepresentative

ptolemy.data.ontologies.FlatTokenRepresentativeConcept

ptolemy.data.ontologies.lattice.unit.DimensionRepresentativeConcept

ptolemy.data.ontologies.lattice.unit.BaseDimensionRepresentativeConcept

All Implemented Interfaces:

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

Direct Known Subclasses:

SIBaseDimensionRepresentativeConcept

public class BaseDimensionRepresentativeConcept
extends DimensionRepresentativeConcept

A representative concept in the unitSystem ontology for a set of units for a specific physical dimension that is one of the 7 base dimensions. There are 7 base dimensions from which all other unit dimensions are derived. These can be specified in a units system ontology by 7 BaseUnitRepresentativeConcepts:

• Mass - SI unit kilograms (kg)
• Position - SI unit meters (m)
• Time - SI unit seconds (sec)
• Current - SI unit amperes (amp)
• Temperature - SI unit Kelvin (K)
• Amount of substance - SI unit moles (mol)
• Intensity of light - SI unit candela (cd)

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

See Also:

BaseUnitConcept

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 inherited from class ptolemy.data.ontologies.lattice.unit.DimensionRepresentativeConcept

_userDefinedUnitRecords, unitInfoRecords

Fields inherited from class ptolemy.data.ontologies.FiniteConcept

abovePort, belowPort

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

Constructor and Description
BaseDimensionRepresentativeConcept(CompositeEntity ontology, java.lang.String name) Create a new BaseUnitRepresentativeConcept with the specified name and ontology.

Method Summary

Modifier and Type	Method and Description
protected BaseUnitConcept	_createInfiniteConceptInstance(java.lang.String infiniteConceptString) Return a BaseUnitConcept instance from the given concept string representation.
java.util.List<BaseUnitConcept>	getAllUnits() Return a list of all the possible units contained in this base dimension.

Methods inherited from class ptolemy.data.ontologies.lattice.unit.DimensionRepresentativeConcept

_findUnitRecordByName, attributeChanged

Methods inherited from class ptolemy.data.ontologies.FlatTokenRepresentativeConcept

_instantiateFlatTokenInfiniteConcept, containsThisInfiniteConceptString, getFlatTokenInfiniteConceptByToken

Methods inherited from class ptolemy.data.ontologies.InfiniteConceptRepresentative

_clearInstantiatedInfiniteConcepts, clone, getInfiniteConceptByString, getInstantiatedInfiniteConcepts

Methods inherited from class ptolemy.data.ontologies.FiniteConcept

getCoverSetAbove, getCoverSetBelow, getIncomingPort, getOutgoingPort, toString

Methods inherited from class ptolemy.data.ontologies.Concept

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

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, 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, 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

equals, finalize, getClass, hashCode, 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

Constructor Detail

BaseDimensionRepresentativeConcept

public BaseDimensionRepresentativeConcept(CompositeEntity ontology,
                                          java.lang.String name)
                                   throws NameDuplicationException,
                                          IllegalActionException

Create a new BaseUnitRepresentativeConcept with the specified name and ontology.

Parameters:

ontology - The specified ontology where this concept resides.

name - The specified name for the concept.

Throws:

NameDuplicationException - If the ontology already contains a concept with the specified name.

IllegalActionException - If the base class throws it.

Method Detail

getAllUnits

public java.util.List<BaseUnitConcept> getAllUnits()
                                            throws IllegalActionException

Return a list of all the possible units contained in this base dimension.

Overrides:

getAllUnits in class DimensionRepresentativeConcept

Returns:

The list of all BaseUnitConcepts that have this BaseDimensionRepresentativeConcept as a representative.

Throws:

IllegalActionException - Thrown if there is a problem getting any unit concepts from the ontology.

_createInfiniteConceptInstance

protected BaseUnitConcept _createInfiniteConceptInstance(java.lang.String infiniteConceptString)
                                                  throws IllegalActionException

Return a BaseUnitConcept instance from the given concept string representation. The string must represent one of the units specified for this physical dimension.

Specified by:

_createInfiniteConceptInstance in class DimensionRepresentativeConcept

Parameters:

infiniteConceptString - The string that represents the unit concept to be returned.

Returns:

The BaseUnitConcept represented by the given string.

Throws:

IllegalActionException - Thrown if there is a problem creating the unit concept.