Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Reference

A reference to a Frame structure object in a file.
Contained in: FrameCPP::Version_3_4_5
Derived from: none
Derived by: none

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


public function member index:

inline Reference(); Default Constructor.
inline Reference(INT_2U classId, INT_2U instance); Constructor.
inline Reference(const Reference& ref); Copy Constructor.
inline INT_2U getClass() const; Get the class ID for this reference.
inline INT_2U getInstance() const; Get the instance number for this reference.
inline bool operator !=(const Reference& ref) const; Not equal comparison operator.
inline bool operator <(const Reference& ref) const; Less than comparison operator.
inline bool operator <=(const Reference& ref) const; Less than or equal to comparison operator.
const Reference& operator =(const Reference& ref); Assignment operator.
inline bool operator ==(const Reference& ref) const; Equal comparison operator.
inline bool operator >(const Reference& ref) const; Greater than comparison operator.
inline bool operator >=(const Reference& ref) const; Greater than or equal to comparison operator.
 

Description:



Function Member Descriptions:


FrameCPP::Version_3_4_5::Reference::Reference - Default Constructor.


inline Reference();
This creates a reference to the zeroth instance of class ID 0.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::Reference - Constructor.


inline Reference(INT_2U classId, INT_2U instance);

Parameters:
ParameterDescription
INT_2U classIdStructure class ID.
INT_2U instanceStructure instance.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::Reference - Copy Constructor.


inline Reference(const Reference& ref);

Parameters:
ParameterDescription
const Reference& refObject to be copied.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::getClass - Get the class ID for this reference.


inline INT_2U getClass() const;

Return value:
INT_2U- Class ID.


FrameCPP::Version_3_4_5::Reference::getInstance - Get the instance number for this reference.


inline INT_2U getInstance() const;

Return value:
INT_2U- Class instance.


FrameCPP::Version_3_4_5::Reference::operator != - Not equal comparison operator.


inline bool operator !=(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& refObject with which to compare.

Return value:
bool- True if this object is not equal to `ref'. bool -- True if this object is not equal to `ref'.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::operator < - Less than comparison operator.


inline bool operator <(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& refObject with which to compare.

Return value:
bool- True if this object is less that `ref'. bool -- True if this object is less that `ref'.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::operator <= - Less than or equal to comparison operator.


inline bool operator <=(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& refObject with which to compare.

Return value:
bool- True if this object is less than or equal so `ref' bool -- True if this object is less than or equal so `ref'

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::operator = - Assignment operator.


const Reference& operator =(const Reference& ref);

Parameters:
ParameterDescription
const Reference& refObject to be assigned.

Return value:
const Reference&- This object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Reference::operator == - Equal comparison operator.


inline bool operator ==(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& refObject with which to compare.

Return value:
bool- True if objects have the same data. bool -- True if objects have the same data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::operator > - Greater than comparison operator.


inline bool operator >(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& ref

Return value:
bool- True is this object is greater that `ref'. bool -

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Reference::operator >= - Greater than or equal to comparison operator.


inline bool operator >=(const Reference& ref) const;

Parameters:
ParameterDescription
const Reference& refObject with which to compare.
const Reference& refObject with which to compare.

Return value:
bool- True if this object is greater that or equal to `ref'. bool -- True if this object is greater that or equal to `ref'.

Exceptions:
ExceptionDescription
None.
None.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Reference::mReference - Structure ID << 16 & Structure Instance.

INT_4U mReference;