MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Protected Attributes
DtPrinterBuf Class Reference

Buffers data output by a DtBufferPrinter. More...

+ Collaboration diagram for DtPrinterBuf:

List of all members.

Public Member Functions

 DtPrinterBuf ()
 Constructor.
virtual ~DtPrinterBuf ()
 Destructor.
 DtPrinterBuf (DtPrinterBuf const &)
 Copy constructor.
virtual DtPrinterBufoperator= (DtPrinterBuf const &)
 Assignment operator.
virtual const DtLogEntryreadNext ()
 Returns a pointer to the next entry to be read.
virtual void write (const std::string &st, MAKRti::DtNotifyLevelType level)
 Writes the given string and notification level to the buffer.
virtual void copyBufferToList (DtLogEntryList &destList) const
 Copies the buffer into the specified list of entries.
virtual void writeBufferToOutputStreams () const
 Writes the entire contents of the current buffer to the MAKRti::DtOutputStreams.
virtual void clearBuffer ()
 Clears the buffer.
virtual void setMaxEntries (int max)
 Sets the maximum number of entries. Negative indicates no limit.

Protected Attributes

DtLogEntryList myBuffer
 The complete buffer is stored as a list of strings and notification levels.
DtLogEntrymyInProcessEntry
 The entry being processed.
int myMaxEntries
 The maximum number of entries. Negative indicates no limit.

Detailed Description

Buffers data output by a DtBufferPrinter.

A DtPrinterBuf is used by a DtBufferPrinter to store any data output by attached output streams.


Constructor & Destructor Documentation

Constructor.

Destructor.

References clearBuffer(), and myInProcessEntry.

Copy constructor.

References copyBufferToList(), and myBuffer.


Member Function Documentation

void DtPrinterBuf::clearBuffer ( ) [virtual]

Clears the buffer.

References myBuffer.

Referenced by ~DtPrinterBuf().

void DtPrinterBuf::copyBufferToList ( DtLogEntryList destList) const [virtual]

Copies the buffer into the specified list of entries.

References myBuffer.

Referenced by DtPrinterBuf(), operator=(), and writeBufferToOutputStreams().

DtPrinterBuf & DtPrinterBuf::operator= ( DtPrinterBuf const &  otherBuf) [virtual]

Assignment operator.

References copyBufferToList(), and myBuffer.

const DtLogEntry * DtPrinterBuf::readNext ( ) [virtual]

Returns a pointer to the next entry to be read.

Please note that the previous entry which was read will be deleted at this time.

References myBuffer, and myInProcessEntry.

void DtPrinterBuf::setMaxEntries ( int  max) [virtual]

Sets the maximum number of entries. Negative indicates no limit.

References myMaxEntries.

void DtPrinterBuf::write ( const std::string &  st,
MAKRti::DtNotifyLevelType  level 
) [virtual]

Writes the given string and notification level to the buffer.

References DtLogEntry::level, myBuffer, myMaxEntries, and DtLogEntry::str.

void DtPrinterBuf::writeBufferToOutputStreams ( ) const [virtual]

Writes the entire contents of the current buffer to the MAKRti::DtOutputStreams.

References copyBufferToList().


Member Data Documentation

The complete buffer is stored as a list of strings and notification levels.

Referenced by clearBuffer(), copyBufferToList(), DtPrinterBuf(), operator=(), readNext(), and write().

The entry being processed.

Referenced by readNext(), and ~DtPrinterBuf().

int DtPrinterBuf::myMaxEntries [protected]

The maximum number of entries. Negative indicates no limit.

Referenced by setMaxEntries(), and write().


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)