Class Index | Cross Index | Namespace Index |
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. |
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const SH& sh | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const std::string& name | Structure name. |
INT_2U classId | Structure class ID. |
const std::string& comment | Comment. |
Parameters:
Parameter | Description |
Input& in | Input data stream object. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Data read failure. |
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const SE& se | Structure element. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Determines whether two SH objects are equal.
Parameters:
Parameter | Description |
const SH& sh | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
INT_2U | Described structure class ID. |
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&- Comment.
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
Container< SE >&- Structure element container.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const Container< SE >&- Structure element container.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const SH& sh | Object to be assigned. |
Return value:
const SH&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two SH objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const SH& sh | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
Input& in | Input data stream object. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Parameters:
Parameter | Description |
Output& out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |