gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class GoComponentPortEvent

java.lang.Object
  extended by java.util.EventObject
      extended by gov.sandia.ccaffeine.dc.user_iface.MVC.event.GoComponentPortEvent
All Implemented Interfaces:
java.io.Serializable

public class GoComponentPortEvent
extends java.util.EventObject

Tis event can be used to notify components that this entity wants to invoke the "go" command on a specific port that is located on a specific component. A view might respond by sending a "go" or a "run" message to the cca server.

See Also:
Serialized Form

Field Summary
protected  java.lang.String componentInstanceName
           
protected  java.lang.String portInstanceName
          The name of the GO port.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GoComponentPortEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName)
          Create a GoComponentPortEvent.
 
Method Summary
 java.lang.String getComponentInstanceName()
           
 java.lang.String getPortInstanceName()
          Get the name of the GO port.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

componentInstanceName

protected java.lang.String componentInstanceName

portInstanceName

protected java.lang.String portInstanceName
The name of the GO port.

Constructor Detail

GoComponentPortEvent

public GoComponentPortEvent(java.lang.Object source,
                            java.lang.String componentInstanceName,
                            java.lang.String portInstanceName)
Create a GoComponentPortEvent. This event can be used to notify components that this entity wants to invoke the "go" command on a specific port that is located on a specific component. A view might respond by sending a "go" or a "run" message to the cca server.

Parameters:
source - The entity that created this event
componentInstanceName - The name of the cca component object. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0"
portInstanceName - The name of the GO port
Method Detail

getComponentInstanceName

public java.lang.String getComponentInstanceName()

getPortInstanceName

public java.lang.String getPortInstanceName()
Get the name of the GO port.

Returns:
The instance name of the GO port.