|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.sandia.ccaffeine.dc.user_iface.AccessServer
public class AccessServer
This class allows the client to send querries and commands to the cca server.
Constructor Summary | |
---|---|
AccessServer()
|
Method Summary | |
---|---|
void |
addGuiListener(GuiListener listener)
|
void |
broadcastConnect(ConnectEvent event)
The client wants the cca server to connect two ports. |
void |
broadcastConnect(java.lang.String sourceComponentName,
java.lang.String sourcePort,
java.lang.String targetComponentName,
java.lang.String targetPort)
The client wants the cca server to connect two ports. |
void |
broadcastDisconnect(DisconnectEvent event)
The client wants the cca server to break the connection that exists between two ports. |
void |
broadcastDisconnect(java.lang.String sourceComponentName,
java.lang.String sourcePort,
java.lang.String targetComponentName,
java.lang.String targetPort)
The client wants the cca server to break the connection that exists between two ports. |
void |
broadcastDisplayComponent(DisplayComponentEvent event)
The client wants the cca server to retrieve information on a specific component. |
void |
broadcastDisplayComponent(java.lang.String componentInstanceName)
The client wants the cca server to retrieve information on a specific component. |
void |
broadcastDisplayPalette()
The client wants the cca server to retrieve information on every component that is inside the palette. |
void |
broadcastDisplayPalette(DisplayPaletteEvent event)
The client wants the cca server to retrieve information on every component that is inside the palette. |
void |
broadcastDisplayState()
The client wants the cca server to retrieve information on every component and every connection that is in the arena. |
void |
broadcastDisplayState(DisplayStateEvent event)
The client wants the cca server to retrieve information on every component and every connection that is in the arena. |
void |
broadcastExit()
The client wants to tell the cca server that it is shutting down. |
void |
broadcastExit(ExitEvent event)
The client wants to tell the cca server that it is shutting down. |
void |
broadcastGetAllInstancesInArena()
The client wants the cca server to retrieve information on all components that are inside the arena. |
void |
broadcastGetAllInstancesInArena(GetInstancesEvent event)
The client wants the cca server to retrieve information on all components that are inside the arena. |
void |
broadcastGetComponentProperty(GetComponentPropertyEvent event)
The client wants the cca server to retrieve the value of a specific property that is contained inside a specific component. |
void |
broadcastGetComponentProperty(java.lang.String componentInstanceName,
java.lang.String propertyName)
The client wants the cca server to retrieve the value of a specific property that is contained inside a specific component. |
void |
broadcastGetPortParameter(ParamGetCurrentEvent event)
The client wants the cca server to retrieve the value of one of the parameters that are inside a port. |
void |
broadcastGetPortParameter(java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String dataFieldName)
The client wants the cca server to retrieve the value of one of the parameters that are inside a port. |
void |
broadcastGo()
The client wants the cca server to lanuch the applicaton. |
void |
broadcastGo(GoEvent event)
The client wants the cca server to lanuch the applicaton. |
void |
broadcastGoComponentPort(GoComponentPortEvent event)
The client wants the cca server to launch by application by invoking the "go" command on a specific port that is inside a specific component. |
void |
broadcastGoComponentPort(java.lang.String componentInstanceName,
java.lang.String portInstanceName)
The client wants the cca server to launch by application by invoking the "go" command on a specific port that is inside a specific component. |
void |
broadcastHeartbeat()
The client wants to send a heartbeat to the cca server. |
void |
broadcastHeartbeat(HeartbeatEvent event)
The client wants to send a heartbeat to the cca server. |
void |
broadcastInstantiate(InstantiateEvent event)
The client wants the cca server to instantatiate a component. |
void |
broadcastInstantiate(java.lang.String className,
java.lang.String instanceName)
The client wants the cca server to instantatiate a component. |
void |
broadcastLinks()
The client wants the cca server to retrieve information on every connection that is inside the arena. |
void |
broadcastLinks(DisplayChainEvent event)
The client wants the cca server to retrieve information on every connection that is inside the arena. |
void |
broadcastMessage(java.lang.String message)
The client wants to send a message to the cca server. |
void |
broadcastMessage(StringEvent event)
The client wants to send a message to the cca server. |
void |
broadcastNukeAll()
The client wants the cca server to destroy all of the instantiated components (i.e. |
void |
broadcastNukeAll(NukeAllEvent event)
The client wants the cca server to destroy all of the instantiated components (i.e. |
void |
broadcastPath(PathEvent event)
The client wants either to tell the cca server the name of the folder that contains cca component or to ask the cca server to retrieve the name of the folder. |
void |
broadcastPathAppendDir(java.lang.String dirname)
The client wants the cca server to add a directory to the component path. |
void |
broadcastRemove(java.lang.String componentInstanceName)
The client wants the cca server to remove an instantiation of a cca component. |
protected void |
broadcastRemoveEvent(RemoveEvent event)
The client wants the cca server to remove an instantiation of a cca component. |
protected void |
broadcastRepository(RepositoryEvent event)
The client wants either to tell the cca server something about hte repository. |
void |
broadcastRepositoryGetGlobal(java.lang.String componentname)
The client wants the cca server to add a component to the pallette. |
void |
broadcastSetComponentProperty(SetComponentPropertyEvent event)
The client wants the cca server to set the value of a specific property that is contained inside a specific component. |
void |
broadcastSetComponentProperty(java.lang.String componentInstanceName,
java.lang.String propertyName,
java.lang.String propertyValue)
The client wants the cca server to set the value of a specific property that is contained inside a specific component. |
void |
broadcastSetDebug()
The client wants the cca server to print debugging statements. |
void |
broadcastSetDebug(SetDebugEvent event)
The client wants the cca server to print debugging statements. |
void |
broadcastSetNoDebug()
The client wants the cca server to stop printing debugging statements. |
void |
broadcastSetNoDebug(SetDebugEvent event)
The client wants the cca server to stop printing debugging statements. |
void |
broadcastSetPortParameter(ParamCurrentEvent event)
The client wants the cca server to set the value of one of the parameters that are inside a port. |
void |
broadcastSetPortParameter(java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String dataFieldName,
java.lang.String dataFieldValue)
The client wants the cca server to set the value of one of the parameters that are inside a port. |
void |
removeGuiListener(GuiListener listener)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AccessServer()
Method Detail |
---|
public void addGuiListener(GuiListener listener)
public void removeGuiListener(GuiListener listener)
public void broadcastRemove(java.lang.String componentInstanceName)
componentInstanceName
- The name of the component that was removed.
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "StartComponent0"protected void broadcastRemoveEvent(RemoveEvent event)
event
- The event that is generated whenever
the GUI is requesting that a component be removed.public void broadcastGo()
public void broadcastGo(GoEvent event)
The
- event that is generated whenever the
GUI is requesting that the application be launched.public void broadcastPathAppendDir(java.lang.String dirname)
dirname
- Full path to append.public void broadcastRepositoryGetGlobal(java.lang.String componentname)
componentname
- Full babel-style class name (or palette alias if known).public void broadcastInstantiate(java.lang.String className, java.lang.String instanceName)
className
- The name of the component's class.
The name is actually the name of the component's
java class.
EXAMPLE: "gov.sandia.ccaffeine.dc.component.PrinterComponent"instanceName
- 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"public void broadcastInstantiate(InstantiateEvent event)
The
- event that is generated whenever the
GUI is requesting that a component be instantiated.public void broadcastConnect(java.lang.String sourceComponentName, java.lang.String sourcePort, java.lang.String targetComponentName, java.lang.String targetPort)
sourceComponentName
- The name of the component
that houses the source port. The "source" is the entity
that is requesting the connection. The "source"
is to be connected to the "target."
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "StartComponent0"sourcePortName
- The name of the source port.
The "source" is the entity that is requesting the connection.
The "source" is to be connected to the "target."
Example: "out0"targetComponentName
- The name of the component
that houses the target port. The "target" is the entity
that receives the connection request. The "source"
is to be connected to the "target."
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "PrinterComponent0"targetPortName
- the name of the target port.
The "target" is the entity
that receives the connection request. The "source"
is to be connected to the "target."
Example: "out0"public void broadcastConnect(ConnectEvent event)
The
- event that is generated whenever the
GUI wants to connect a ProvidesPort to a
UsesPort.public void broadcastDisconnect(java.lang.String sourceComponentName, java.lang.String sourcePort, java.lang.String targetComponentName, java.lang.String targetPort)
sourceComponentName
- The name of the component
that houses the source port. The "source" is the entity
that originally requested the connection. The "source"
is connected to the "target."
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "StartComponent0"sourcePortName
- The name of the source port.
The "source" is the entity that originally requested the connection.
The "source" is connected to the "target."
Example: "out0"targetComponentName
- The name of the component
that houses the target port. The "target" is the entity
that originally received the connection request. The "source"
is to be connected to the "target."
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "PrinterComponent0"targetPortName
- the name of the target port.
The "target" is the entity that originally received
the connection request. The "source"
is connected to the "target."
Example: "out0"public void broadcastDisconnect(DisconnectEvent event)
The
- event that is generated whenever the
GUI wants to disconnect the connection between a ProvidesPort
and a UsesPort.public void broadcastGetAllInstancesInArena()
public void broadcastGetAllInstancesInArena(GetInstancesEvent event)
event
- The event that is generated whenever
the GUI wants to get information on all of the instantiated
components.public void broadcastSetPortParameter(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldValue)
componentInstanceName
- The name of the cca component that contains
the port.
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 parameter.
Example: "configure_port"dataFieldName
- The name of the parameter.public void broadcastSetPortParameter(ParamCurrentEvent event)
The
- event that is generated whenever the
GUI wants to set the value of a port parameter.public void broadcastGetPortParameter(java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName)
componentInstanceName
- The name of the cca component that contains
the port.
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 parameter.
Example: "configure_port"dataFieldName
- The name of the parameter.public void broadcastGetPortParameter(ParamGetCurrentEvent event)
event
- The event that is created when the GUI
wants to get the value of a parameter.public void broadcastSetDebug()
public void broadcastSetDebug(SetDebugEvent event)
public void broadcastSetNoDebug()
public void broadcastSetNoDebug(SetDebugEvent event)
public void broadcastDisplayPalette()
public void broadcastDisplayPalette(DisplayPaletteEvent event)
event
- The event that is generated whenever
the GUI wants to know what components
are in the palette.public void broadcastLinks()
public void broadcastLinks(DisplayChainEvent event)
event
- The event that is created
whenever the GUI wants to know what connections
are in the arena.public void broadcastDisplayComponent(java.lang.String componentInstanceName)
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"public void broadcastDisplayComponent(DisplayComponentEvent event)
event
- The event that is created
whenever the GUI wants some information
on a cca component.public void broadcastDisplayState()
public void broadcastDisplayState(DisplayStateEvent event)
event
- The event that is created whenever
the GUI wants to know the state of the arena.public void broadcastGoComponentPort(java.lang.String componentInstanceName, java.lang.String portInstanceName)
componentInstanceName
- The name of the
cca component object that
contains the "go" port. 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 portpublic void broadcastGoComponentPort(GoComponentPortEvent event)
event
- The event that is generated whenever
the GUI wants to invoke the "go" command.public void broadcastNukeAll()
public void broadcastNukeAll(NukeAllEvent event)
public void broadcastGetComponentProperty(java.lang.String componentInstanceName, java.lang.String propertyName)
componentInstanceName
- The name of the component that contains the property
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "StartComponent0"propertyName
- The name of the property.public void broadcastGetComponentProperty(GetComponentPropertyEvent event)
event
- The event that is generated
whenever the GUi wants the value of a
property.public void broadcastSetComponentProperty(java.lang.String componentInstanceName, java.lang.String propertyName, java.lang.String propertyValue)
componentInstanceName
- The name of the component that contains the property.
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "StartComponent0"propertyName
- The name of the property.propertyValue
- The value of the property.public void broadcastSetComponentProperty(SetComponentPropertyEvent event)
event
- The event that is created whenever
the GUI wants to set the value of a property.public void broadcastMessage(java.lang.String message)
message
- The message that is to
be sent to the cca server.public void broadcastMessage(StringEvent event)
event
- The event that is created
whenever the GUi wants to send
a string to the cca server.public void broadcastHeartbeat()
public void broadcastHeartbeat(HeartbeatEvent event)
event
- The event that is fabricated
whenever the GUI wants to send a heartbeat to the cca server.public void broadcastExit()
public void broadcastExit(ExitEvent event)
event
- The event that is generated whenever
the GUI wants to exit the application.public void broadcastPath(PathEvent event)
event
- The event that is
generated whenever the GUI
wants the cca server either to set the path
to a new value or to query
for the path value.protected void broadcastRepository(RepositoryEvent event)
event
- The event that is
generated by the GUI
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |