MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Private Member Functions
DtMessageQueue__rti__ Class Reference

This is an abstract base class presenting an interface for a simple message queue. More...

+ Inheritance diagram for DtMessageQueue__rti__:

List of all members.

Public Member Functions

 DtMessageQueue__rti__ ()
virtual ~DtMessageQueue__rti__ ()
virtual bool isEmpty ()=0
 returns true if there are no messages to be read.
virtual bool sendMessage (const void *message, unsigned int messageSize)=0
 Inserts message of size messageSize into queue.
virtual void * message (unsigned int *outSize=0)=0
 Returns a pointer to the oldest message in the queue, returns 0 if there are no messages waiting in the queue.
virtual std::ostream & printDataToStream (std::ostream &str) const =0
 Prints the internal state of the queue to a stream.

Private Member Functions

 DtMessageQueue__rti__ (const DtMessageQueue__rti__ &other)
 Copy Ctor Not Implimented -- Class Not Copiable.
DtMessageQueue__rti__operator= (const DtMessageQueue__rti__ &other)
 Assignment Operator Not Implimented -- Class Not Copiable.

Detailed Description

This is an abstract base class presenting an interface for a simple message queue.

Messages of arbitrary size can be sent, and read with FIFO.


Constructor & Destructor Documentation

Copy Ctor Not Implimented -- Class Not Copiable.


Member Function Documentation

virtual bool DtMessageQueue__rti__::isEmpty ( ) [pure virtual]

returns true if there are no messages to be read.

Implemented in DtSmSubscribableMessageQueue__rti__.

virtual void* DtMessageQueue__rti__::message ( unsigned int *  outSize = 0) [pure virtual]

Returns a pointer to the oldest message in the queue, returns 0 if there are no messages waiting in the queue.

Implemented in DtSmSubscribableMessageQueue__rti__.

DtMessageQueue__rti__& DtMessageQueue__rti__::operator= ( const DtMessageQueue__rti__ other) [private]

Assignment Operator Not Implimented -- Class Not Copiable.

virtual std::ostream& DtMessageQueue__rti__::printDataToStream ( std::ostream &  str) const [pure virtual]

Prints the internal state of the queue to a stream.

Implemented in DtSmSubscribableMessageQueue__rti__.

Referenced by operator<<().

virtual bool DtMessageQueue__rti__::sendMessage ( const void *  message,
unsigned int  messageSize 
) [pure virtual]

Inserts message of size messageSize into queue.

Implemented in DtSmSubscribableMessageQueue__rti__.


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)