Class Index | Cross Index | Namespace Index |
Frame Structure Element.
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/se.hh"
public function member index: |
|||
SE | (const SE& se); | Copy constructor. | |
SE | (const std::string& name, const std::string& type, const std::string& comment); | Constructor. | |
inline const std::string& | getClass | () const; | Get the element type. |
virtual INT_2U | getClassId | () const; | |
inline const std::string& | getComment | () const; | Get the comment. |
const std::string& | getName | () const; | |
const SE& | operator = | (const SE& se); | Assignment Operator.. |
bool | operator == | (const SE& se) const; | Equal comparison. |
private function member index: |
|||
SE | (Input& in); | Input Constructor. | |
static SE* | read | (Input& in); | Instantiates a new SE object from a stream. |
virtual void | write | (Output& out) const; | Write this object. |
This is implemented as a simple class without mutators. The class has no
default constructor.
Parameters:
Parameter | Description |
const SE& se | The object to copy from. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This creates a Structure Element with the given attributes.
Parameters:
Parameter | Description |
const std::string& name | The field name. |
const std::string& type | The Class type |
const std::string& comment | A comment. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This creates a Structure Element by reading it from an Input object.
Parameters:
Parameter | Description |
Input& in | The Input object to read from. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Return value:
const std::string&- The type.
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
const std::string&- The comment.
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const SE& se | The object to assign from. |
Return value:
const SE&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two SE objects are equal. For this comparison, the comments are not compared.
Parameters:
Parameter | Description |
const SE& se | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
This method is used only by the Input object.
Parameters:
Parameter | Description |
Input& in | The object to read from. |
Return value:
SE*- The new object. The user must destruct this object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failed. |
Writes this SE to an output object.
Parameters:
Parameter | Description |
Output& out | The object to write to. |
Exceptions:
Exception | Description |
write_failure | Write failed. |