Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::RawData

Raw Data.
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/rawdata.hh"


public function member index:

RawData(); Default Constructor.
RawData(const RawData& rawData); Copy Constructor.
RawData(const std::string& name); Constructor.
virtual ~RawData();
const AdcData* findAdc(INT_4U channel) const;
AdcData* findAdc(INT_4U channel);
virtual INT_2U getClassId() const;
const std::string& getName() const;
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Constructs frame data vesion 3 Structure Header for this class.
inline bool operator !=(const RawData& rawData) const; Not-equal comparison.
const RawData& operator +=(const RawData& rawData);
const RawData& operator =(const RawData& rawData); Assignment Operator.
bool operator ==(const RawData& rawData) const;
inline AdcDataContainer& refAdc(); Get the container holding the ADC data.
inline const AdcDataContainer& refAdc() const; Get the container holding the ADC data.
inline MoreContainer& refMore();
inline const MoreContainer& refMore() const;
inline MsgContainer& refMsg();
inline const MsgContainer& refMsg() const;
inline SerDataContainer& refSerial(); Get the container holding the serial data.
inline const SerDataContainer& refSerial() const; Get the container holding the serial data.
inline TableContainer& refTable();
inline const TableContainer& refTable() const;
 

private function member index:

static RawData* read(FrameReaderBase& in); Reads an RawData object from an FrameReaderBase object.
static RawData* read3(FrameReaderBase& in); Version 3 frame input method.
virtual void write(Output& out) const; Writes an RawData object to an Output object.
 

Description:

This class represents raw data. It is modeled after the FrRawData structure in the Frame Specification, LIGO-T970130-B-E.


Function Member Descriptions:


FrameCPP::Version_3_4_5::RawData::RawData - Default Constructor.


RawData();
This creates an RawData object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::RawData - Copy Constructor.


RawData(const RawData& rawData);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const RawData& rawDataObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::RawData::RawData - Constructor.


RawData(const std::string& name);

Parameters:
ParameterDescription
const std::string& nameRaw data name.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::RawData::~RawData


virtual ~RawData();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::findAdc


const AdcData* findAdc(INT_4U channel) const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::findAdc


AdcData* findAdc(INT_4U channel);

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::getName


const std::string& getName() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::getSH - Constructs the Structure Header for this class.


static SH getSH();

Return value:
SH- RawData structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::RawData::getSH3 - Constructs frame data vesion 3 Structure Header for this class.


static SH getSH3();

Return value:
SH- RawData structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


inline bool operator !=(const RawData& rawData) const;

Parameters:
ParameterDescription
const RawData& rawDataThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::operator +=


const RawData& operator +=(const RawData& rawData);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
frame_mismatchRaw Data or ADC structures are different



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


const RawData& operator =(const RawData& rawData);

Parameters:
ParameterDescription
const RawData& rawDataObject to be assigned.

Return value:
const RawData&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::RawData::operator ==


bool operator ==(const RawData& rawData) const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::RawData::read - Reads an RawData object from an FrameReaderBase object.


static RawData* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
FrameReaderBase& inInput data stream object.

Return value:
RawData*- Newly created.

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



FrameCPP::Version_3_4_5::RawData::read3 - Version 3 frame input method.


static RawData* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::RawData::refAdc - Get the container holding the ADC data.


inline AdcDataContainer& refAdc();

Return value:
AdcDataContainer& AdcDataContainer&- Adc data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refAdc - Get the container holding the ADC data.


inline const AdcDataContainer& refAdc() const;
Get the container holding the ADC data.

Return value:
const AdcDataContainer& const AdcDataContainer&- Adc data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refMore


inline MoreContainer& refMore();
Get the container holding the user-define data.

Return value:
MoreContainer& MoreContainer&- User defined data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refMore


inline const MoreContainer& refMore() const;
Get the container holding the user-define data.

Return value:
const MoreContainer< Vect, &Vect::getName >& const SearchContainer< Vect, &Vect::getName >&- User defined data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refMsg


inline MsgContainer& refMsg();
Get the container holding the error messages.

Return value:
MsgContainer& MsgContainer&- Messages.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refMsg


inline const MsgContainer& refMsg() const;
Get the container holding the error messages.

Return value:
const MsgContainer& const MsgContainer&- Messages.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refSerial - Get the container holding the serial data.


inline SerDataContainer& refSerial();

Return value:
SerDataContainer&- Serial data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refSerial - Get the container holding the serial data.


inline const SerDataContainer& refSerial() const;

Return value:
const SerDAtaContainer&- Serial data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refTable


inline TableContainer& refTable();
Get the container holding the user-define table data.

Return value:
TableContainer& TableContainer&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::refTable


inline const TableContainer& refTable() const;
Get the container holding the user-define table data.

Return value:
const TableContainer& const TableContainer&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::RawData::write - Writes an RawData object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::RawData::mAdcData - Adc data.

AdcDataContainer mAdcData;

FrameCPP::Version_3_4_5::RawData::mMore - User defined additional data.

MoreContainer mMore;

FrameCPP::Version_3_4_5::RawData::mMsg - Error messages.

MsgContainer mMsg;

FrameCPP::Version_3_4_5::RawData::mName - Name of raw data.

std::string mName;

FrameCPP::Version_3_4_5::RawData::mSerData - Serial data.

SerDataContainer mSerData;

FrameCPP::Version_3_4_5::RawData::mTable - Table of some data.

TableContainer mTable;