The Robot Application Programming Interface Delegate Project
RAPID Logo

RapidCommand Class Reference

Inheritance diagram for RapidCommand:
Collaboration diagram for RapidCommand:

List of all members.

Public Member Functions

 RapidCommand (Command command, CommandConfig config)
void addCommandArgument (String key, DataType type, String param)
void addCommandArgument (KeyTypeValueTriple ktv, String param)
String getCommandSource ()
String getAssetName ()
String getHeaderSourceName ()
Header getCommandHeader ()
DataType getCommandParameterType (String key)
SubsystemType[] getSubsystemTypes ()
Subsystem[] getSubsystems ()
 available subsystems that can be commanded
ParameterUnion[] getAllArguments ()
int getIndexOfKey (String key)
Object getParameterValue (String key)
Float getFloatParameter (String key) throws IncompatibleKeyTypeException
Double getDoubleParameter (String key) throws IncompatibleKeyTypeException
String getStringParameter (String key) throws IncompatibleKeyTypeException
Integer getIntParameter (String key) throws IncompatibleKeyTypeException
Boolean getBooleanParameter (String key) throws IncompatibleKeyTypeException
String toString ()
String getCommandName ()
Copyable getCopyable ()
void setSubsystemName (String subsysName)
void setCmdSource (String srcName)
void setAssetDestination (String assetDst)
void setCmdName (String cmdName)
void setCmdID (String cmdID)
int getArgumentListSize ()

Static Public Member Functions

static String[] getCommandTypesPrettyNames ()
 Need to change this if CommandType in IDL changes: case 0: return CommandType.CTYPE_MOBILITY; case 1: return CommandType.CTYPE_IMAGEACQUIRE; case 2: return CommandType.CTYPE_QUEUEMANAGEMENT; case 3: return CommandType.CTYPE_STATUSREQUEST; case 4: return CommandType.CTYPE_SUBSYSTEM_CALL; case 5: return CommandType.CTYPE_MACRO; case 6: return CommandType.CTYPE_NATIVE;.

Public Attributes

Command command
CommandConfig commandConfig

Static Public Attributes

static final int COMMAND_PARAMETER_TYPES_COUNT = 7
 MAE-4205 This is highly tied to the Generated source.

Constructor & Destructor Documentation

RapidCommand ( Command  command,
CommandConfig  config 
)

Member Function Documentation

void addCommandArgument ( String  key,
DataType  type,
String  param 
)
void addCommandArgument ( KeyTypeValueTriple  ktv,
String  param 
)
ParameterUnion [] getAllArguments ( )
int getArgumentListSize ( )
String getAssetName ( )
Boolean getBooleanParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Header getCommandHeader ( )
String getCommandName ( )
Returns:
String
DataType getCommandParameterType ( String  key)
String getCommandSource ( )
static String [] getCommandTypesPrettyNames ( ) [static]
Returns:
String[]
Copyable getCopyable ( )

Reimplemented from RapidMessageAdapter.

Double getDoubleParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Float getFloatParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

String getHeaderSourceName ( )
int getIndexOfKey ( String  key)
Integer getIntParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Object getParameterValue ( String  key)

Here is the call graph for this function:

String getStringParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Subsystem [] getSubsystems ( )
Returns:
SubsystemType [] getSubsystemTypes ( )
void setAssetDestination ( String  assetDst)
void setCmdID ( String  cmdID)
void setCmdName ( String  cmdName)
void setCmdSource ( String  srcName)
void setSubsystemName ( String  subsysName)
String toString ( )

Implements IRapidMessage.


Member Data Documentation

final int COMMAND_PARAMETER_TYPES_COUNT = 7 [static]

If the generated source changes, this has to change as well


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines