MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Protected Attributes
DtRtiSaveFile Class Reference
+ Collaboration diagram for DtRtiSaveFile:

List of all members.

Public Member Functions

 DtRtiSaveFile (const char *filename)
 constructor
 DtRtiSaveFile (const char *filename, bool readOnly)
 constructor
virtual ~DtRtiSaveFile ()
 destructor
virtual const MAKRti::DtString & fileName ()
 filename
virtual bool isOk ()
 Return boolean: file initialized OK (call after instantiation and set read/write)
virtual void setForRead ()
 set for read
virtual void setForWrite ()
 set for write
virtual void setForAppend ()
 set for append
virtual const char * readNextPacket ()
 get the next packet, returns NULL if setup for writing.
virtual void writePacket (const char *packet, int length)
 write a packet, does nothing if set up for reading

Protected Attributes

bool myReadOnly
char * myCurrentPacket
FILE * myFp
MAKRti::DtString myFileName

Constructor & Destructor Documentation

DtRtiSaveFile::DtRtiSaveFile ( const char *  filename)

constructor

References myCurrentPacket.

DtRtiSaveFile::DtRtiSaveFile ( const char *  filename,
bool  readOnly 
)

constructor

References myCurrentPacket, setForRead(), and setForWrite().

destructor

References myCurrentPacket, myFp, and NULL.


Member Function Documentation

const MAKRti::DtString & DtRtiSaveFile::fileName ( ) [virtual]

filename

References myFileName.

Referenced by DtRtiExecFederateMgr::federateSaveComplete().

bool DtRtiSaveFile::isOk ( ) [virtual]

Return boolean: file initialized OK (call after instantiation and set read/write)

References myFp, and NULL.

Referenced by DtRtiExecFederateMgr::restoreLRC(), and DtRtiExecFederateMgr::saveLRC().

const char * DtRtiSaveFile::readNextPacket ( ) [virtual]
virtual void DtRtiSaveFile::setForAppend ( ) [inline, virtual]

set for append

clears the file from the current packet on. (not implemented yet)

void DtRtiSaveFile::setForRead ( ) [virtual]

set for read

changes the state of the file to read only and moves the file pointer to the beginning of the file.

References myFileName, myFp, myReadOnly, and NULL.

Referenced by DtRtiSaveFile().

void DtRtiSaveFile::setForWrite ( ) [virtual]

set for write

clears the contents of the file and opens it writing.

References myFileName, myFp, myReadOnly, and NULL.

Referenced by DtRtiSaveFile().

void DtRtiSaveFile::writePacket ( const char *  packet,
int  length 
) [virtual]

Member Data Documentation

char* DtRtiSaveFile::myCurrentPacket [protected]
MAKRti::DtString DtRtiSaveFile::myFileName [protected]

Referenced by fileName(), setForRead(), and setForWrite().

FILE* DtRtiSaveFile::myFp [protected]

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)