Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::ObjectHeader

The header for an object in a file.
Contained in: FrameCPP::Version_3_4_5
Derived from: none
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/objectheader.hh"


public function member index:

ObjectHeader(); Default Constructor.
ObjectHeader(INT_4U length, INT_2U fileClass, INT_2U instance, INT_2U localClass); Constructor.
ObjectHeader(const ObjectHeader& oh); Copy Constructor.
inline INT_2U getFileClassId() const; Get the Class ID as defined in the file.
inline INT_2U getInstance() const; Get the instance in the file.
inline INT_4U getLength() const; Get the structure length.
inline INT_2U getLocalClassId() const; Get the Class ID as defined locally.
inline Reference getReference() const; Get a reference to this object.
const ObjectHeader& operator =(const ObjectHeader& oh); Assignment Operator.
 

Description:

This class represents the header which appears before every object stored in a frame file. The header consists of three integers:

  1. The byte count of the object, including the header.
  2. An id for the type of class represented by the object, this is defined at run-time.
  3. The instance counter for this class in this frame.

This class stores this information and provides a mapping between the class ID defined in the file and the class ID defined in memory by FrameCPP.


Function Member Descriptions:


FrameCPP::Version_3_4_5::ObjectHeader::ObjectHeader - Default Constructor.


ObjectHeader();



FrameCPP::Version_3_4_5::ObjectHeader::ObjectHeader - Constructor.


ObjectHeader(INT_4U length, INT_2U fileClass, INT_2U instance, INT_2U localClass);

Parameters:
ParameterDescription
INT_4U lengthStructure length.
INT_2U fileClassStructure class ID.
INT_2U instanceStructure instance number.
INT_2U localClassFrameCPP structure class ID.



FrameCPP::Version_3_4_5::ObjectHeader::ObjectHeader - Copy Constructor.


ObjectHeader(const ObjectHeader& oh);

Parameters:
ParameterDescription
const ObjectHeader& ohAn object to be copied.



FrameCPP::Version_3_4_5::ObjectHeader::getFileClassId - Get the Class ID as defined in the file.


inline INT_2U getFileClassId() const;

Return value:
INT_2UStructure class ID.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ObjectHeader::getInstance - Get the instance in the file.


inline INT_2U getInstance() const;

Return value:
INT_2UStructure instance number.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ObjectHeader::getLength - Get the structure length.


inline INT_4U getLength() const;

Return value:
INT_4UStructure length.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ObjectHeader::getLocalClassId - Get the Class ID as defined locally.


inline INT_2U getLocalClassId() const;

Return value:
INT_2ULocal structure class ID.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ObjectHeader::getReference - Get a reference to this object.


inline Reference getReference() const;
This consists of the File Class ID and the instance.

Return value:
ReferenceNewly constructed reference.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::ObjectHeader::operator = - Assignment Operator.


const ObjectHeader& operator =(const ObjectHeader& oh);

Parameters:
ParameterDescription
const ObjectHeader& ohAn object to be assigned.

Return value:
const ObjectHeader&- This object.


Variable Member Descriptions:


FrameCPP::Version_3_4_5::ObjectHeader::mFileClassId - Structure class ID.

INT_2U mFileClassId;

FrameCPP::Version_3_4_5::ObjectHeader::mInstance - Structure instance number.

INT_2U mInstance;

FrameCPP::Version_3_4_5::ObjectHeader::mLength - Structure length.

INT_4U mLength;

FrameCPP::Version_3_4_5::ObjectHeader::mLocalClassId - FrameCPP structure class ID.

INT_2U mLocalClassId;