Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::EndOfFile

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


public function member index:

EndOfFile(); Default Constructor.
EndOfFile(const EndOfFile& eof); Copy Constructor.
EndOfFile(INT_4U frames, INT_4U bytes, INT_4U chktype, INT_4U chksum, INT_4U seekTOC); Constructor.
virtual ~EndOfFile();
inline INT_4U getChkSum() const; Gets the checksum value.
inline INT_4U getChkType() const; Returns the checksum type.
virtual INT_2U getClassId() const;
inline INT_4U getNBytes() const; Gets the total number of bytes in this file.
inline INT_4U getNFrames() const; Gets the number of frames in this file.
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.
inline INT_4U getSeekTOC() const; Gets the number of bytes to back up to the beginning of the TOC
const EndOfFile& operator =(const EndOfFile& eof); Assignment Operator.
 

private function member index:

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

Description:

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


Function Member Descriptions:


FrameCPP::Version_3_4_5::EndOfFile::EndOfFile - Default Constructor.


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

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFile::EndOfFile - Copy Constructor.


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

Parameters:
ParameterDescription
const EndOfFile& eofObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::EndOfFile::EndOfFile - Constructor.


EndOfFile(INT_4U frames, INT_4U bytes, INT_4U chktype, INT_4U chksum, INT_4U seekTOC);

Parameters:
ParameterDescription
INT_4U framesThe number of frame in the file.
INT_4U bytesThe number of bytes in this file.
INT_4U chktypeChecksum scheme: 0 = none, 1 = CRC.
INT_4U chksumFile checksum.
INT_4U seekTOCBytes to back up to the beginning of the TOC.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFile::~EndOfFile


virtual ~EndOfFile();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFile::getChkSum - Gets the checksum value.


inline INT_4U getChkSum() const;

Return value:
INT_4U- Checksum.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::EndOfFile::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::EndOfFile::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFile::getNBytes - Gets the total number of bytes in this file.


inline INT_4U getNBytes() const;
This is zero if it is not computed.

Return value:
INT_4U- Number of bytes.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::EndOfFile::getNFrames - Gets the number of frames in this file.


inline INT_4U getNFrames() const;

Return value:
INT_4U- Number of frames.

Exceptions:
ExceptionDescription
None.
None.



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


static SH getSH();

Return value:
SH- Structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



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


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::EndOfFile::getSeekTOC - Gets the number of bytes to back up to the beginning of the TOC


inline INT_4U getSeekTOC() const;

Return value:
INT_4U- TOC offset.

Exceptions:
ExceptionDescription
None.
None.



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


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

Parameters:
ParameterDescription
const EndOfFile& eofObject to assign.

Return value:
const EndOfFile&- This object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::EndOfFile::read - Reads an EndOfFile object from an Input object.


static EndOfFile* read(Input& 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
Input& inInput data stream object.

Return value:
EndOfFile*- Newly created.

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



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


static EndOfFile* read3(Input& in);

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



FrameCPP::Version_3_4_5::EndOfFile::read4 - Version 4 frame input method.


static EndOfFile* read4(Input& in);

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



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


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::EndOfFile::mChkSum - File checksum.

INT_4U mChkSum;

FrameCPP::Version_3_4_5::EndOfFile::mChkType - Checksum scheme: 0 = none, 1 = CRC.

INT_4U mChkType;

FrameCPP::Version_3_4_5::EndOfFile::mNBytes - The number of bytes in this file.

INT_4U mNBytes;

FrameCPP::Version_3_4_5::EndOfFile::mNFrames - The number of frame in the file.

INT_4U mNFrames;

FrameCPP::Version_3_4_5::EndOfFile::mSeekTOC - Bytes to back up to the beginning of the TOC.

INT_4U mSeekTOC;