Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::SH

Frame Structure Header.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

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


public function member index:

inline SH(); Default Constructor.
inline SH(const SH& sh); Copy Constructor.
inline SH(const std::string& name, INT_2U classId, const std::string& comment); Constructor.
virtual ~SH();
inline void appendSE(const SE&); Add a SE to this header.
bool equal(const SH& sh) const; Equal comparison (all data except class ID number).
inline INT_2U getClass() const; Get the class ID of the class which this SH describes.
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Get the comment.
const std::string& getName() const;
inline Container< SE >& getSE(); Get the SE container.
inline const Container< SE >& getSE() const; Get the SE container.
const SH& operator =(const SH& sh); Assignment Operator.
bool operator ==(const SH& sh) const; Equal comparison.
 

private function member index:

SH(Input& in); Input constructor.
static SH* read(Input& in); Read the SH from an Input object.
virtual void write(Output& out) const; Writes the SH to an Output object.
 

Description:



Function Member Descriptions:


FrameCPP::Version_3_4_5::SH::SH - Default Constructor.


inline SH();

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SH::SH - Copy Constructor.


inline SH(const SH& sh);

Parameters:
ParameterDescription
const SH& shObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SH::SH - Constructor.


inline SH(const std::string& name, INT_2U classId, const std::string& comment);

Parameters:
ParameterDescription
const std::string& nameStructure name.
INT_2U classIdStructure class ID.
const std::string& commentComment.



FrameCPP::Version_3_4_5::SH::SH - Input constructor.


SH(Input& in);

Parameters:
ParameterDescription
Input& inInput data stream object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureData read failure.



FrameCPP::Version_3_4_5::SH::~SH


virtual ~SH();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SH::appendSE - Add a SE to this header.


inline void appendSE(const SE&);

Parameters:
ParameterDescription
const SE& seStructure element.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SH::equal - Equal comparison (all data except class ID number).


bool equal(const SH& sh) const;
Determines whether two SH objects are equal.

Parameters:
ParameterDescription
const SH& shThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SH::getClass - Get the class ID of the class which this SH describes.


inline INT_2U getClass() const;

Parameters:
ParameterDescription
INT_2UDescribed structure class ID.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SH::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SH::getComment - Get the comment.


inline const std::string& getComment() const;

Return value:
const std::string&- Comment.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SH::getName


const std::string& getName() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SH::getSE - Get the SE container.


inline Container< SE >& getSE();

Return value:
Container< SE >&- Structure element container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SH::getSE - Get the SE container.


inline const Container< SE >& getSE() const;

Return value:
const Container< SE >&- Structure element container.

Exceptions:
ExceptionDescription
None.
None.



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


const SH& operator =(const SH& sh);

Parameters:
ParameterDescription
const SH& shObject to be assigned.

Return value:
const SH&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


bool operator ==(const SH& sh) const;
Determines whether two SH objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const SH& shThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SH::read - Read the SH from an Input object.


static SH* read(Input& in);

Parameters:
ParameterDescription
Input& inInput data stream object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::SH::write - Writes the SH to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::SH::mClass - Class number of structure beeing described.

INT_2U mClass;

FrameCPP::Version_3_4_5::SH::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::SH::mName - Name of structure beeing described by this object.

std::string mName;

FrameCPP::Version_3_4_5::SH::mSE - Structure elements for the described structure.

Container< SE > mSE;