FileQueueState Class Reference

ChannelStatus is used to indicate whether a RAPID File Queue (part of the RAPID File Transfer Service) is currently capable of transferring files (Active) or is temporarily refraining from transferring files (Paused). More...

Inheritance diagram for FileQueueState:

Collaboration diagram for FileQueueState:

List of all members.

Public Member Functions
	FileQueueState ()
	FileQueueState (FileQueueState 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
boolean	connected
	Connection status of the file queue.
int	bandwidth
int	prefetchBandwidth
gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence	channels = (gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence) gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence.create()
	The state of the individual channels.

---

Detailed Description

• FILE_QUEUE_CHANNEL_ACTIVE: Capable of transferring files.
• FILE_QUEUE_CHANNEL_PAUSED: Temporarily refraining from transferring files.

Holds information about a file that could be transferred to the ground from the robot.

---

Constructor & Destructor Documentation

FileQueueState

(

)

FileQueueState

(

FileQueueState

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 FileQueueStateTypeSupport 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

int bandwidth

gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence channels = (gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence) gov.nasa.rapid.idl.dds.rapid.ChannelStateSequence.create()

boolean connected

The queue will not send data as long as there is no reader connected.

int prefetchBandwidth

---

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

• FileQueueState.java