org.kepler.sms.actors

Class SimpleMergeMapping

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

org.kepler.sms.actors.SimpleMergeMapping

All Implemented Interfaces:

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

public class SimpleMergeMapping
extends Attribute

This is an attribute that gets attached to a configured merge actor instance. The attribute denotes a simple mapping from a source port to a target port. Also, a single conversion can be applied to the source port as part of the mapping (in particular, a simple unit conversion)

Author:

Shawn Bowers

Created:

October 17, 2005

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

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
SimpleMergeMapping(NamedObj container, java.lang.String name) Constructor
SimpleMergeMapping(NamedObj container, java.lang.String name, java.lang.String sourceActor, java.lang.String sourcePort, java.lang.String targetPort) Constructor
SimpleMergeMapping(NamedObj container, java.lang.String name, java.lang.String sourceActor, java.lang.String sourcePort, java.lang.String targetPort, java.lang.String conversion) Constructor
SimpleMergeMapping(java.lang.String sourceActor, java.lang.String sourcePort, java.lang.String targetPort) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getConversion()
java.lang.String	getSourceActor()
java.lang.String	getSourceActorPort()
java.lang.String	getTargetPort()
static void	main(java.lang.String[] args) For testing
void	setContainer(NamedObj container) Specify the container NamedObj, adding this attribute to the list of attributes in the container.
void	setConversion(java.lang.String name) Set the name of the conversion
void	setSourceActor(java.lang.String name) Set the name of the source actor
void	setSourceActorPort(java.lang.String name) Set the name of the source actor port
void	setTargetPort(java.lang.String name) Set the name of the target port

Methods inherited from class ptolemy.kernel.util.Attribute

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, 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, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMergeMapping

public SimpleMergeMapping(java.lang.String sourceActor,
                          java.lang.String sourcePort,
                          java.lang.String targetPort)
                   throws IllegalActionException,
                          NameDuplicationException

Constructor

Throws:

IllegalActionException

NameDuplicationException

SimpleMergeMapping

public SimpleMergeMapping(NamedObj container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException

Constructor

Throws:

IllegalActionException

NameDuplicationException

SimpleMergeMapping

public SimpleMergeMapping(NamedObj container,
                          java.lang.String name,
                          java.lang.String sourceActor,
                          java.lang.String sourcePort,
                          java.lang.String targetPort)
                   throws IllegalActionException,
                          NameDuplicationException

Constructor

Throws:

IllegalActionException

NameDuplicationException

SimpleMergeMapping

public SimpleMergeMapping(NamedObj container,
                          java.lang.String name,
                          java.lang.String sourceActor,
                          java.lang.String sourcePort,
                          java.lang.String targetPort,
                          java.lang.String conversion)
                   throws IllegalActionException,
                          NameDuplicationException

Constructor

Throws:

IllegalActionException

NameDuplicationException

Method Detail

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

Description copied from class: Attribute

Specify the container NamedObj, adding this attribute to the list of attributes in the container. If the container already contains an attribute with the same name, then throw an exception and do not make any changes. Similarly, if the container is not in the same workspace as this attribute, throw an exception. If this attribute is already contained by the NamedObj, do nothing. If the attribute already has a container, remove this attribute from its attribute list first. Otherwise, remove it from the directory of the workspace, if it is there. If the argument is null, then remove it from its container. It is not added to the workspace directory, so this could result in this object being garbage collected. Note that since an Attribute is a NamedObj, it can itself have attributes. However, recursive containment is not allowed, where an attribute is an attribute of itself, or indirectly of any attribute it contains. This method is write-synchronized on the workspace and increments its version number.

Subclasses may constrain the type of container by overriding Attribute.setContainer(NamedObj).

Overrides:

setContainer in class Attribute

Parameters:

container - The container for this attribute

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute.

See Also:

Attribute.getContainer()

getSourceActor

public java.lang.String getSourceActor()

Returns:

The name of the source actor

getSourceActorPort

public java.lang.String getSourceActorPort()

Returns:

The name of the source actor port

getTargetPort

public java.lang.String getTargetPort()

Returns:

The name of the target port

getConversion

public java.lang.String getConversion()

Returns:

The name of the conversion

setSourceActor

public void setSourceActor(java.lang.String name)
                    throws IllegalActionException,
                           NameDuplicationException

Set the name of the source actor

Throws:

IllegalActionException

NameDuplicationException

setSourceActorPort

public void setSourceActorPort(java.lang.String name)
                        throws IllegalActionException,
                               NameDuplicationException

Set the name of the source actor port

Throws:

IllegalActionException

NameDuplicationException

setTargetPort

public void setTargetPort(java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException

Set the name of the target port

Throws:

IllegalActionException

NameDuplicationException

setConversion

public void setConversion(java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException

Set the name of the conversion

Throws:

IllegalActionException

NameDuplicationException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

main

public static void main(java.lang.String[] args)

For testing