The Robot Application Programming Interface Delegate Project
RAPID Logo

Ack Class Reference

Status of the command paired with this Ack. More...

Inheritance diagram for Ack:
Collaboration diagram for Ack:

List of all members.

Public Member Functions

 Ack ()
 Ack (Ack 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 cmdID = ""
 Command ID of command being acknowledged.
gov.nasa.rapid.idl.dds.rapid.AckStatus status = (gov.nasa.rapid.idl.dds.rapid.AckStatus) gov.nasa.rapid.idl.dds.rapid.AckStatus.create()
gov.nasa.rapid.idl.dds.rapid.AckCompletedStatus completedStatus = (gov.nasa.rapid.idl.dds.rapid.AckCompletedStatus) gov.nasa.rapid.idl.dds.rapid.AckCompletedStatus.create()
 Details how the task completed.
String message = ""
 Message details any exceptions made during Ack transition.

Detailed Description

  • ACK_QUEUED: Sent by Sequencer when queueing Tasks.
  • ACK_EXECUTING: Command has been started by the Bridge.
  • ACK_COMPLETED: Sent when command is done.

This status is sent along when it has completed

  • ACK_COMPLETED_NOT: Task has not completed yet.
  • ACK_COMPLETED_OK: Successful completion.
  • ACK_COMPLETED_BAD_SYNTAX: Command not recognized, bad parameters, etc.
  • ACK_COMPLETED_EXEC_FAILED: Failed to complete.
  • ACK_COMPLETED_CANCELED: Canceled from queue.

Ack is a Message that sends an acknowledgement of commands received.


Constructor & Destructor Documentation

Ack ( )
Ack ( Ack  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 AckTypeSupport 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)

Reimplemented from Message.

Here is the call graph for this function:

static Object create ( ) [static]

Reimplemented from Message.

Here is the call graph for this function:

boolean equals ( Object  o)

Reimplemented from Message.

Here is the call graph for this function:

int hashCode ( )

Reimplemented from Message.

String toString ( String  desc,
int  indent 
)

Reimplemented from Message.

Here is the call graph for this function:

String toString ( )

Reimplemented from Message.


Member Data Documentation

String cmdID = ""
String message = ""

Analogous to exception message string.

gov.nasa.rapid.idl.dds.rapid.AckStatus status = (gov.nasa.rapid.idl.dds.rapid.AckStatus) gov.nasa.rapid.idl.dds.rapid.AckStatus.create()
See also:
AckStatus.

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