The Robot Application Programming Interface Delegate Project
RAPID Logo

ChannelState 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 ChannelState:
Collaboration diagram for ChannelState:

List of all members.

Public Member Functions

 ChannelState ()
 ChannelState (ChannelState 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.ChannelStatus status = (gov.nasa.rapid.idl.dds.rapid.ChannelStatus) gov.nasa.rapid.idl.dds.rapid.ChannelStatus.create()
 Status of file in queue.
long queuedDataVolume
 Size of queued data volume.
short queuedFiles
 Number of queued files.

Detailed Description

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

Constructor & Destructor Documentation

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 ChannelStateTypeSupport 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 ( )
String toString ( String  desc,
int  indent 
)

Here is the call graph for this function:

String toString ( )

Member Data Documentation

short queuedFiles
gov.nasa.rapid.idl.dds.rapid.ChannelStatus status = (gov.nasa.rapid.idl.dds.rapid.ChannelStatus) gov.nasa.rapid.idl.dds.rapid.ChannelStatus.create()

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