Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::SE

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.
 

Description:

This class represents the Frame Structure Element object as given in the Frame Specification. It stores information about a single field in a frame structure. The information stored is:

  1. name - The name of the field.
  2. class - The class type, e.g. "INT_2U" or "REAL_8".
  3. comment

This is implemented as a simple class without mutators. The class has no default constructor.


Function Member Descriptions:


FrameCPP::Version_3_4_5::SE::SE - Copy constructor.


SE(const SE& se);

Parameters:
ParameterDescription
const SE& seThe object to copy from.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SE::SE - Constructor.


SE(const std::string& name, const std::string& type, const std::string& comment);
This creates a Structure Element with the given attributes.

Parameters:
ParameterDescription
const std::string& nameThe field name.
const std::string& typeThe Class type
const std::string& commentA comment.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SE::SE - Input Constructor.


SE(Input& in);
This creates a Structure Element by reading it from an Input object.

Parameters:
ParameterDescription
Input& inThe Input object to read from.

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



FrameCPP::Version_3_4_5::SE::getClass - Get the element type.


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

Return value:
const std::string&- The type.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SE::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



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


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

Return value:
const std::string&- The comment.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SE::getName


const std::string& getName() const;

Exceptions:
ExceptionDescription
None.



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


const SE& operator =(const SE& se);

Parameters:
ParameterDescription
const SE& seThe object to assign from.

Return value:
const SE&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


bool operator ==(const SE& se) const;
Determines whether two SE objects are equal. For this comparison, the comments are not compared.

Parameters:
ParameterDescription
const SE& seThe object to compare with.

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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SE::read - Instantiates a new SE object from a stream.


static SE* read(Input& in);
This method is used only by the Input object.

Parameters:
ParameterDescription
Input& inThe object to read from.

Return value:
SE*- The new object. The user must destruct this object.

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



FrameCPP::Version_3_4_5::SE::write - Write this object.


virtual void write(Output& out) const;
Writes this SE to an output object.

Parameters:
ParameterDescription
Output& outThe object to write to.

Exceptions:
ExceptionDescription
write_failureWrite failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::SE::mClass - Element data type.

std::string mClass;

FrameCPP::Version_3_4_5::SE::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::SE::mName - Name of the element described.

std::string mName;