The Robot Application Programming Interface Delegate Project
RAPID Logo

CommandDef Class Reference

A command definition. More...

Inheritance diagram for CommandDef:
Collaboration diagram for CommandDef:

List of all members.

Public Member Functions

 CommandDef ()
 CommandDef (CommandDef other)
boolean equals (Object o)
int hashCode ()
Object copy_from (Object src)
 This is the implementation of the Copyable interface.
String toString ()
String toString (String desc, int indent)

Static Public Member Functions

static Object create ()

Public Attributes

String name = ""
 The name of the command, to be used as cmdName in Command.
boolean abortable
 Describes whether or not this command can be aborted once begun.
boolean suspendable
 Describes whether or not this command can be suspended once begun.
gov.nasa.rapid.idl.dds.rapid.KeyTypeSequence16 parameters = (gov.nasa.rapid.idl.dds.rapid.KeyTypeSequence16) gov.nasa.rapid.idl.dds.rapid.KeyTypeSequence16.create()
 The arguments needed to send this command: key is the name of the argument, type is the expected data type of the argument.

Detailed Description

Arguments will define name of argument as Key, type of argument as Type.


Constructor & Destructor Documentation

CommandDef ( CommandDef  other)

Here is the call graph for this function:


Member Function Documentation

Object copy_from ( Object  src)

This method will perform a deep copy of src This method could be placed into CommandDefTypeSupport rather than here by using the -noCopyable option to rtiddsgen.

Parameters:
srcThe Object which contains the data to be copied.
Returns:
Returns this.
Exceptions:
NullPointerExceptionIf src is null.
ClassCastExceptionIf src is not the same type as this.
See also:
com.rti.dds.infrastructure.Copyable.copy_from(java.lang.Object)

Here is the call graph for this function:

static Object create ( ) [static]

Here is the call graph for this function:

boolean equals ( Object  o)

Here is the call graph for this function:

int hashCode ( )

Here is the call graph for this function:

String toString ( String  desc,
int  indent 
)

Here is the call graph for this function:

String toString ( )

Member Data Documentation

boolean abortable
String name = ""
boolean suspendable

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