ptolemy.actor.parameters
Class LocationParameter
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.util.Attribute
ptolemy.kernel.util.AbstractSettableAttribute
ptolemy.data.expr.Variable
ptolemy.data.expr.Parameter
ptolemy.actor.parameters.LocationParameter
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, Locatable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable, ValueListener
public class LocationParameter
- extends Parameter
- implements Locatable
A parameter that specifies the location of its container.
This location is used when rendering the container in a Vergil diagram.
The parameter value is a double matrix with one row and two columns.
The default value is [0.0, 0.0].
- Since:
- Ptolemy II 3.0
- Version:
- $Id: LocationParameter.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Constructor Summary |
LocationParameter(NamedObj container,
java.lang.String name)
Construct a parameter with the given name contained by the specified
entity. |
Method Summary |
java.lang.String |
getDisplayName()
Return a name to present to the user, which
is the same as the name returned by getName(). |
double[] |
getLocation()
Get the location in some Cartesian coordinate system. |
void |
setLocation(double[] location)
Set the location in some Cartesian coordinate system, and notify
the container and any value listeners of the new location. |
Methods inherited from class ptolemy.data.expr.Variable |
_description, _evaluate, _notifyValueListeners, _parseIfNecessary, _propagate, _propagateToValueListeners, _propagateValue, _setToken, _setTokenAndNotify, addValueListener, clone, getDeclaredType, getExpression, getFreeIdentifiers, getParserScope, getScope, getScope, getToken, getType, getTypeTerm, getValueAsString, getVariable, getVisibility, invalidate, isKnown, isLazy, isStringMode, isTypeAcceptable, removeValueListener, reset, setContainer, setExpression, setLazy, setName, setParseTreeEvaluator, setStringMode, setToken, setToken, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, setUnknown, setVisibility, stringRepresentation, toString, typeConstraintList, typeConstraints, validate, valueChanged |
Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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 |
LocationParameter
public LocationParameter(NamedObj container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct a parameter with the given name contained by the specified
entity. The container argument must not be null, or a
NullPointerException will be thrown. This parameter will use the
workspace of the container for synchronization and version counts.
If the name argument is null, then the name is set to the empty string.
The object is not added to the list of objects in the workspace
unless the container is null.
Increment the version of the workspace.
- Parameters:
container
- The container.name
- The name of the parameter.
- Throws:
IllegalActionException
- If the parameter is not of an
acceptable class for the container.
NameDuplicationException
- If the name coincides with
a parameter already in the container.
getDisplayName
public java.lang.String getDisplayName()
- Return a name to present to the user, which
is the same as the name returned by getName().
- Specified by:
getDisplayName
in interface Nameable
- Specified by:
getDisplayName
in interface Settable
- Overrides:
getDisplayName
in class NamedObj
- Returns:
- A name to present to the user.
- See Also:
NamedObj.setDisplayName(String)
getLocation
public double[] getLocation()
- Get the location in some Cartesian coordinate system.
- Specified by:
getLocation
in interface Locatable
- Returns:
- The location.
- See Also:
setLocation(double [])
setLocation
public void setLocation(double[] location)
throws IllegalActionException
- Set the location in some Cartesian coordinate system, and notify
the container and any value listeners of the new location. This
also propagates the value to derived objects.
- Specified by:
setLocation
in interface Locatable
- Parameters:
location
- The location.
- Throws:
IllegalActionException
- If the location is rejected.- See Also:
getLocation()