MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
MAKLogger::DtLoggerOutputFile Class Reference

A file opened for reading. More...

+ Inheritance diagram for MAKLogger::DtLoggerOutputFile:
+ Collaboration diagram for MAKLogger::DtLoggerOutputFile:

Public Member Functions

 DtLoggerOutputFile (const DtString &filename, int version, bool truncate=true)
 Opens a file for output and writes the version and any meta data. More...
 
virtual ~DtLoggerOutputFile ()
 DTOR. More...
 
virtual int fileDescriptor ()
 Get the file descriptor to access the file. More...
 
virtual DtFilePosition startOfData ()
 Get the position for the start of data. More...
 
virtual DtFilePosition fileSize ()
 The size of the output file. More...
 
- Public Member Functions inherited from MAKLogger::DtLoggerFile
virtual ~DtLoggerFile ()
 DTOR. More...
 
virtual int fileVersion () const
 Get the file version. More...
 
virtual const DtString & filename () const
 Get the file name. More...
 

Protected Member Functions

void openFileForOutput (bool truncate=true)
 Non virtual since called by constructor. More...
 
void writeFileVersion (int version)
 Non virtual since called by constructor. More...
 
virtual void setFileDescriptor (int fd)
 Set the file descriptor. More...
 
- Protected Member Functions inherited from MAKLogger::DtLoggerFile
 DtLoggerFile (const DtString &filename, int fileVersion)
 Create a Logger file from an existing file. More...
 
virtual void setFileVersion (int fileVersion)
 Set the file version. More...
 
virtual void setFilename (const DtString &filename)
 Set the filename. More...
 

Protected Attributes

int myFileDescriptor
 
- Protected Attributes inherited from MAKLogger::DtLoggerFile
DtString myFilename
 
int myFileVersion
 

Private Member Functions

 DtLoggerOutputFile (const DtLoggerOutputFile &)
 Not Implemented. More...
 
DtLoggerOutputFileoperator= (const DtLoggerOutputFile &)
 Not Implemented. More...
 

Detailed Description

A file opened for reading.

Constructor & Destructor Documentation

MAKLogger::DtLoggerOutputFile::DtLoggerOutputFile ( const DtString &  filename,
int  version,
bool  truncate = true 
)

Opens a file for output and writes the version and any meta data.

Exceptions
DtFileWriteErrorif the version can't be written to the file.
MAKLogger::DtLoggerOutputFile::DtLoggerOutputFile ( const DtLoggerOutputFile )
private

Not Implemented.

virtual MAKLogger::DtLoggerOutputFile::~DtLoggerOutputFile ( )
virtual

DTOR.

Member Function Documentation

virtual int MAKLogger::DtLoggerOutputFile::fileDescriptor ( )
virtual

Get the file descriptor to access the file.

Implements MAKLogger::DtLoggerFile.

virtual DtFilePosition MAKLogger::DtLoggerOutputFile::fileSize ( )
virtual

The size of the output file.

void MAKLogger::DtLoggerOutputFile::openFileForOutput ( bool  truncate = true)
protected

Non virtual since called by constructor.

DtLoggerOutputFile& MAKLogger::DtLoggerOutputFile::operator= ( const DtLoggerOutputFile )
private

Not Implemented.

virtual void MAKLogger::DtLoggerOutputFile::setFileDescriptor ( int  fd)
protectedvirtual

Set the file descriptor.

virtual DtFilePosition MAKLogger::DtLoggerOutputFile::startOfData ( )
virtual

Get the position for the start of data.

Typically there are version and meta data before the actual data.

void MAKLogger::DtLoggerOutputFile::writeFileVersion ( int  version)
protected

Non virtual since called by constructor.

Member Data Documentation

int MAKLogger::DtLoggerOutputFile::myFileDescriptor
protected

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

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)