Class Index | Cross Index | Namespace Index |
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. |
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.
Parameters:
Parameter | Description |
INT_4U length | Structure length. |
INT_2U fileClass | Structure class ID. |
INT_2U instance | Structure instance number. |
INT_2U localClass | FrameCPP structure class ID. |
Parameters:
Parameter | Description |
const ObjectHeader& oh | An object to be copied. |
Return value:
INT_2UStructure class ID.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_2UStructure instance number.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4UStructure length.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_2ULocal structure class ID.
Exceptions:
Exception | Description |
None. | |
None. |
This consists of the File Class ID and the instance.
Return value:
ReferenceNewly constructed reference.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const ObjectHeader& oh | An object to be assigned. |
Return value:
const ObjectHeader&- This object.