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

Contains. More...

+ Collaboration diagram for MAKLogger::DtLoggerFileMetaData:

Public Types

enum  DataPosition { StartOfFile, EndOfFile, MiddleOfFile }
 

Public Member Functions

 DtLoggerFileMetaData ()
 
virtual ~DtLoggerFileMetaData ()
 DTOR. More...
 
virtual void addMetaData (DataPosition, DtPacket *)
 Add meta data to a specific position. More...
 
virtual void addUniqueMetaData (DataPosition position, DtPacket *packet)
 Add unique meta data to a specific position. More...
 
virtual const DtPacketgetMetaData (DataPosition position, int type) const
 Get meta data of a specific type, from a position. More...
 
virtual void clearMetaData (DataPosition)
 Clear the meta data for a specific region. More...
 
virtual DtMessageBuffergetMetaData (DataPosition position)
 Get meta data for a specific position suitable for writing. More...
 
virtual const DtMessageBuffergetMetaData (DataPosition) const
 Get meta data for a specific position suitable for writing. More...
 

Protected Types

typedef std::map< DataPosition,
DtMessageBuffer
MetaDataMap
 

Protected Attributes

MetaDataMap myMetaDataMap
 Map that stores meta data packets. More...
 

Detailed Description

Contains.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
StartOfFile 

Supported in many file versions.

EndOfFile 

Supported in many file versions.

MiddleOfFile 

Not supported in many file versions.

Constructor & Destructor Documentation

MAKLogger::DtLoggerFileMetaData::DtLoggerFileMetaData ( )
virtual MAKLogger::DtLoggerFileMetaData::~DtLoggerFileMetaData ( )
virtual

DTOR.

Member Function Documentation

virtual void MAKLogger::DtLoggerFileMetaData::addMetaData ( DataPosition  ,
DtPacket  
)
virtual

Add meta data to a specific position.

Packet owner ship is transfered to this object.

Exceptions
DtInvalidInputif the packet pointer is null.
virtual void MAKLogger::DtLoggerFileMetaData::addUniqueMetaData ( DataPosition  position,
DtPacket packet 
)
virtual

Add unique meta data to a specific position.

Packet is added uniquely to the position buffer. Any packets in the buffer with the same type will first be removed and deleted, before adding the new packet. Packet owner ship is transfered to this object.

Exceptions
DtInvalidInputif the packet pointer is null.
virtual void MAKLogger::DtLoggerFileMetaData::clearMetaData ( DataPosition  )
virtual

Clear the meta data for a specific region.

Internal meta data for a specific region is deallocated,

Exceptions
DtInvalidInputif the position has does not exist.
virtual const DtPacket* MAKLogger::DtLoggerFileMetaData::getMetaData ( DataPosition  position,
int  type 
) const
virtual

Get meta data of a specific type, from a position.

Returns
returns a pointer to the first packet of that type in the position. If a packet is not found a null pointer is returned.
Return values
0a packet of the input type was not found.
Exceptions
DtInvalidInputif the position has does not exist.
virtual DtMessageBuffer& MAKLogger::DtLoggerFileMetaData::getMetaData ( DataPosition  position)
virtual

Get meta data for a specific position suitable for writing.

Exceptions
DtInvalidInputif the position has does not exist.
virtual const DtMessageBuffer& MAKLogger::DtLoggerFileMetaData::getMetaData ( DataPosition  ) const
virtual

Get meta data for a specific position suitable for writing.

Exceptions
DtInvalidInputif the position has does not exist.

Member Data Documentation

MetaDataMap MAKLogger::DtLoggerFileMetaData::myMetaDataMap
protected

Map that stores meta data packets.


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)