kaos.brahms.blik.example
Class BLIKCmdRobotSearch

java.lang.Object
  kaos.brahms.blik.example.BLIKCmdRobotSearch

All Implemented Interfaces:

FeedbackReceiver

public class BLIKCmdRobotSearch
extends java.lang.Object
implements FeedbackReceiver

This class is an example of how to search for robots in the KAoS Directory Service, send to the robots various commands (actions) via BLIK and receive feedback about the execution of the sent commands.

Field Summary

protected BLIK

_blik

Constructor Summary

BLIKCmdRobotSearch(BLIK blik, java.lang.String myName)

Method Summary

static void	main(java.lang.String[] args)
void	onAborted(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the requested action is aborted.
void	onAccepted(java.util.Calendar time, java.lang.Object acceptInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the requested action is accepted by the robot.
void	onCompleted(java.util.Calendar time, java.lang.Object result, java.lang.String actionID, java.lang.String robotID) This method is invoked upon completion of the requested command by the robot.
void	onRefused(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the requested action is refused by the robot.
void	onStarted(java.util.Calendar time, java.lang.Object startedInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the robot starts the requested action/command.
void	receiveKAoSStatus(java.lang.String statusMsg, java.lang.String actionID, java.lang.String robotID) Receive a status message describing the execution of the requested action.
void	test()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_blik

protected BLIK _blik

Constructor Detail

BLIKCmdRobotSearch

public BLIKCmdRobotSearch(BLIK blik,
                          java.lang.String myName)
                   throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

onAccepted

public void onAccepted(java.util.Calendar time,
                       java.lang.Object acceptInfo,
                       java.lang.String actionID,
                       java.lang.String robotID)

This method is invoked when the requested action is accepted by the robot.

Specified by:

onAccepted in interface FeedbackReceiver

Parameters:

time - Calendar time of acceptance.

acceptInfo - Object containing additional (optional) info about the acceptance.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onRefused

public void onRefused(java.util.Calendar time,
                      java.lang.Object reason,
                      java.lang.String actionID,
                      java.lang.String robotID)

This method is invoked when the requested action is refused by the robot.

Specified by:

onRefused in interface FeedbackReceiver

Parameters:

time - Calendar time of refusal.

reason - Object containing the reason for refusing the request.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onCompleted

public void onCompleted(java.util.Calendar time,
                        java.lang.Object result,
                        java.lang.String actionID,
                        java.lang.String robotID)

This method is invoked upon completion of the requested command by the robot.

Specified by:

onCompleted in interface FeedbackReceiver

Parameters:

time - Calendar time of information/action completion.

result - Object containing the result of the requested action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onStarted

public void onStarted(java.util.Calendar time,
                      java.lang.Object startedInfo,
                      java.lang.String actionID,
                      java.lang.String robotID)

This method is invoked when the robot starts the requested action/command.

Specified by:

onStarted in interface FeedbackReceiver

Parameters:

time - Calendar time of starting an action.

startedInfo - Object containing additional (optional) info about the start of the action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onAborted

public void onAborted(java.util.Calendar time,
                      java.lang.Object reason,
                      java.lang.String actionID,
                      java.lang.String robotID)

This method is invoked when the requested action is aborted.

Specified by:

onAborted in interface FeedbackReceiver

Parameters:

time - Calendar time of aborting an action.

reason - Object containing the reason for aborting an action.

actionID - String containing the id of the requested action.

robotID - String containing the name of the robot performing the action.

receiveKAoSStatus

public void receiveKAoSStatus(java.lang.String statusMsg,
                              java.lang.String actionID,
                              java.lang.String robotID)

Receive a status message describing the execution of the requested action. There maybe several status messages sent during action execution.

Specified by:

receiveKAoSStatus in interface FeedbackReceiver

Parameters:

statusMsg - Object containing the result of the requested action/information.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

test

public void test()

main

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

Throws:

java.lang.Exception