Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::EndOfFrame

This class represents the end of a frame.
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/endofframe.hh"


public function member index:

EndOfFrame(); Default Constructor.
EndOfFrame(const EndOfFrame& eof); Copy Constructor.
EndOfFrame(INT_4S run, INT_4U frame, INT_4U chktype, INT_4U chksum); Constructor.
virtual ~EndOfFrame();
inline INT_4U getChkSum() const; Gets frame checksum value.
inline INT_4U getChkType() const; Returns the checksum type.
virtual INT_2U getClassId() const;
inline INT_4U getFrame() const; Get the frame number.
inline INT_4S getRun() const; Get the run number.
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Constructs frame data format version 3 Structure Header for this class.
static SH getSH4(); Constructs frame data format version 4 Structure Header for this class.
const EndOfFrame& operator =(const EndOfFrame& eof); Assignment Operator.
 

private function member index:

static EndOfFrame* read(FrameReaderBase& in); Reads an EndOfFrame object from an FrameReaderBase object.
static EndOfFrame* read3(FrameReaderBase& in); Version 3 Frame read method.
static EndOfFrame* read4(FrameReaderBase& in); Version 4 Frame read method.
virtual void write(Output& out) const; Writes an EndOfFrame object to an Output object.
 

Description:

It is modeled after the FrEndOfFrame structure in the Frame Specification, LIGO-T970130-B-E.


Function Member Descriptions:


FrameCPP::Version_3_4_5::EndOfFrame::EndOfFrame - Default Constructor.


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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFrame::EndOfFrame - Copy Constructor.


EndOfFrame(const EndOfFrame& eof);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const EndOfFrame& eofrThe object to be copied.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFrame::EndOfFrame - Constructor.


EndOfFrame(INT_4S run, INT_4U frame, INT_4U chktype, INT_4U chksum);

Parameters:
ParameterDescription
INT_4S runFrame run number.
INT_4U frameFrame number
INT_4U chktypeFrame checksum scheme.
INT_4U chksumFile checksum.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFrame::~EndOfFrame


virtual ~EndOfFrame();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFrame::getChkSum - Gets frame checksum value.


inline INT_4U getChkSum() const;

Return value:
INT_4U- Frame checksum.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::EndOfFrame::getChkType - Returns the checksum type.


inline INT_4U getChkType() const;
This is one is CRC checksum was calculated, zero if not. All other values are unused as of version 5 of frame data format.

Return value:
INT_4U- Checksum type.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::EndOfFrame::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFrame::getFrame - Get the frame number.


inline INT_4U getFrame() const;

Return value:
INT_4U- Frame number.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::EndOfFrame::getRun - Get the run number.


inline INT_4S getRun() const;

Return value:
INT_4S- Run number.

Exceptions:
ExceptionDescription
None.
None.



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


static SH getSH();

Return value:
SH- End of frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::EndOfFrame::getSH3 - Constructs frame data format version 3 Structure Header for this class.


static SH getSH3();

Return value:
SH- End of frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::EndOfFrame::getSH4 - Constructs frame data format version 4 Structure Header for this class.


static SH getSH4();

Return value:
SH- End of frame structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


const EndOfFrame& operator =(const EndOfFrame& eof);

Parameters:
ParameterDescription
const EndOfFrame& eofrObject to be assigned.

Return value:
const EndOfFrame&- This object.

Exceptions:
ExceptionDescription
None.



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


static EndOfFrame* 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:
EndOfFrame*- Newly created.

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



FrameCPP::Version_3_4_5::EndOfFrame::read3 - Version 3 Frame read method.


static EndOfFrame* read3(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::EndOfFrame::read4 - Version 4 Frame read method.


static EndOfFrame* read4(FrameReaderBase& in);

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



FrameCPP::Version_3_4_5::EndOfFrame::write - Writes an EndOfFrame 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::EndOfFrame::mChkSum - File checksum.

INT_4U mChkSum;

FrameCPP::Version_3_4_5::EndOfFrame::mChkType - Checksum schemes: 0 = none, 1 = CRC.

INT_4U mChkType;

FrameCPP::Version_3_4_5::EndOfFrame::mFrame - Frame number.

INT_4U mFrame;

FrameCPP::Version_3_4_5::EndOfFrame::mRun - Frame run number.

INT_4S mRun;