QueueState Class Reference

ResultType describes the result of a command on the completed queue. More...

Inheritance diagram for QueueState:

Collaboration diagram for QueueState:

List of all members.

Public Member Functions
	QueueState ()
	QueueState (QueueState 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
gov.nasa.rapid.idl.dds.rapid.SingleQueue	pending = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()
gov.nasa.rapid.idl.dds.rapid.SingleQueue	active = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()
gov.nasa.rapid.idl.dds.rapid.SingleQueue	completed = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()
gov.nasa.rapid.idl.dds.rapid.SingleQueue	sent = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()

---

Detailed Description

• Q_STATUS_INIT:
• Q_STATUS_OUTBOUND: SENT
• Q_STATUS_LOST: SENT
• Q_STATUS_INLINE: PENDING
• Q_STATUS_PREEMPTED: PENDING
• Q_STATUS_INPROCESS: ACTIVE
• Q_STATUS_PAUSED: ACTIVE
• Q_STATUS_CANCELED: COMPLETED
• Q_STATUS_SUCCEEDED: COMPLETED
• Q_STATUS_FAILED: COMPLETED
• Q_STATUS_ALIEN_PENDING:
• Q_STATUS_ALIEN_ACTIVE:
• Q_STATUS_ALIEN_COMPLETED:
• Q_STATUS_FORGOTTEN_BY_ROBOT:

• Q_RESULT_INIT:
• Q_RESULT_SUCCEEDED:
• Q_RESULT_FAILED:

CommandRecord holds a command, its status and its result. SingleQueue holds a sequence of CommandRecords. Maximum length for a SingleQueue is 64. QueueState is a message that holds single queues of pending, active, completed and sent commands. This is primarily used with a Sequencer that handles the queueing of commands.

---

Constructor & Destructor Documentation

QueueState

(

)

QueueState

(

QueueState

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 QueueStateTypeSupport rather than here by using the -noCopyable option to rtiddsgen.

Parameters:

src	The Object which contains the data to be copied.

Returns:

Returns this.

Exceptions:

NullPointerException	If src is null.
ClassCastException	If 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.

Here is the call graph for this function:

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

gov.nasa.rapid.idl.dds.rapid.SingleQueue active = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()

gov.nasa.rapid.idl.dds.rapid.SingleQueue completed = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()

gov.nasa.rapid.idl.dds.rapid.SingleQueue pending = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()

gov.nasa.rapid.idl.dds.rapid.SingleQueue sent = (gov.nasa.rapid.idl.dds.rapid.SingleQueue) gov.nasa.rapid.idl.dds.rapid.SingleQueue.create()

---

The documentation for this class was generated from the following file:

• QueueState.java