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

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

public class ParamGetCurrentEvent
extends java.util.EventObject

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that an entity wants the value of one of these data fields. A view entity might respond by sending a "configure" or a "parameters" message to the cca server.

See Also:
Serialized Form

Field Summary
protected  java.lang.String componentInstanceName
           
protected  java.lang.String dataFieldName
          The name of a data field.
protected  java.lang.String portInstanceName
          The name of the port that contains the data field.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ParamGetCurrentEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName)
          Create a ParamGetCurrentEvent.
 
Method Summary
 java.lang.String getComponentInstanceName()
           
 java.lang.String getDataFieldName()
          Get the name of a data field.
 java.lang.String GetPortInstanceName()
          Get the name of the port that contains the data field.
 
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 port that contains the data field. Example: "configure_port"


dataFieldName

protected java.lang.String dataFieldName
The name of a data field.

Constructor Detail

ParamGetCurrentEvent

public ParamGetCurrentEvent(java.lang.Object source,
                            java.lang.String componentInstanceName,
                            java.lang.String portInstanceName,
                            java.lang.String dataFieldName)
Create a ParamGetCurrentEvent.

Cca components contain ports. Some of the ports contain data fields. This event can be used to notify components that an entity wants to get the value of one of the data fields. A view entity might respond by sending a "configure" or a "parameters" message to the cca server.

Parameters:
source - The entity that created this event.
componentInstanceName - The name of the cca component that contains the port which contains the data field. The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
portInstanceName - The name of a port that contains the data field. Example: "configure_port"
dataFieldName - The name of the data field.
Method Detail

getComponentInstanceName

public java.lang.String getComponentInstanceName()

GetPortInstanceName

public java.lang.String GetPortInstanceName()
Get the name of the port that contains the data field.

Returns:
The instance name of the port.

getDataFieldName

public java.lang.String getDataFieldName()
Get the name of a data field.

Returns:
The name of the data field.