ptolemy.domains.wireless.lib
Class NodeRandomizer
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.domains.wireless.lib.NodeRandomizer
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class NodeRandomizer
- extends TypedAtomicActor
This actor, when fired, randomizes the locations of all actors in the
same container that contain an attribute named "randomize" with value
true. It can also optionally perform the randomization in its
preinitialize() method. In both cases, the randomization is
performed in a change request, so it will take effect after the
current iteration.
This actor assumes that the location is represented in an object
of class Locatable (which is an attribute that implements Settable)
with name "_location". This is how Vergil represents locations.
The range parameter is an array of arrays giving the range
of possible values for each dimension of the location. For example,
if the location is in two dimensions, then range has the form
{{x1, x2}, {y1, y2}},
indicating that the X value of the location is uniformly
distributed between x1 and x2, and that the Y value is
uniformly distributed between y1 and y2.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: NodeRandomizer.java,v 1.14 2004/04/14 19:25:40 neuendor Exp $
- Author:
- Sanjeev Kohli, N. Vinay Krishnan, Cheng Tien Ee, Edward Lee and Xiaojun Liu
- See Also:
Locatable,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
NodeRandomizer(CompositeEntity container,
java.lang.String name)
Construct an actor in the given container with the given name.
|
|
Method Summary |
protected java.lang.String |
_getLocationSetMoML(CompositeEntity container,
Entity node,
double[] location)
Return moml that will set the location of the specified node.
|
protected void |
_randomize()
Randomly distribute the nodes in the model that contain a
boolean valued parameter named "randomize" with value true.
|
void |
fire()
Issue a change request to randomize the locations of the nodes. |
void |
preinitialize()
Override the base class to randomize the positions of the nodes
if randomizeInPreinitialize is set to true. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
randomizeInPreinitialize
public Parameter randomizeInPreinitialize
- If set to true, randomly distribute nodes in preinitialize().
The default value is false.
range
public Parameter range
- The range of values for locations to be set when randomizing.
This is an array of arrays that defaults to
{{0.0, 500.0}, {0.0, 500.0}},
indicating that the X and Y values are uniformly distributed
between 0.0 and 500.0.
seed
public Parameter seed
- The seed that controls the random number generation to use when
randomizing.
A seed of zero is interpreted to mean that no seed is specified,
which means that each execution of the model could result in
distinct data. For the value 0, the seed is set to
System.currentTimeMillis() + hashCode(), which means that
with extremely high probability, two distinct actors will have
distinct seeds. However, current time may not have enough
resolution to ensure that two subsequent executions of the
same model have distinct seeds.
This parameter contains a LongToken, initially with value 0.
trigger
public TypedIOPort trigger
- A trigger input to cause this actor to fire in domains
that require a trigger. This has undeclared type.
NodeRandomizer
public NodeRandomizer(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor in the given container with the given name.
The container argument must not be null, or a
NullPointerException will be thrown.
If the name argument is null, then the name is set to the
empty string. Increment the version number of the workspace.
- Parameters:
container - Container of the actor.name - Name of the actor.
- Throws:
IllegalActionException - If the
actor is not compatible with the specified container.
NameDuplicationException - If the name collides
with an entity in the container.
fire
public void fire()
throws IllegalActionException
- Issue a change request to randomize the locations of the nodes.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If the superclass throws it.
preinitialize
public void preinitialize()
throws IllegalActionException
- Override the base class to randomize the positions of the nodes
if randomizeInPreinitialize is set to true. Also initialize
the random number generator so that if a nonzero seed is provided,
then the results are repeatable.
- Specified by:
preinitialize in interface Executable- Overrides:
preinitialize in class AtomicActor
- Throws:
IllegalActionException - If the initialize() method of
one of the associated actors throws it, or if the range parameter
is malformed.
_randomize
protected void _randomize()
throws IllegalActionException
- Randomly distribute the nodes in the model that contain a
boolean valued parameter named "randomize" with value true.
This method distributes the location according to uniform
random variables (one for each dimension) with ranges given
by the range parameter. Subclasses can override this
to perform some other randomization. This delegates to the
method _setLocationOfNode() to actually set the location of the
actor.
- Throws:
IllegalActionException - If the range parameter is malformed.
_getLocationSetMoML
protected java.lang.String _getLocationSetMoML(CompositeEntity container,
Entity node,
double[] location)
throws IllegalActionException
- Return moml that will set the location of the specified node.
The moml should set the _location attribute, which is the
location as used in Vergil, the visual editor. Derived
classes may override this to store the location differently.
- Parameters:
location - The specified location.node - The node for which to set the location.
- Throws:
IllegalActionException - If the location attribute
cannot be set.