Class Index | Cross Index | Namespace Index |
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. |
This creates an EndOfFrame object with the following properties:
- run = 0
- frame = 0
- chkType = 0
- chkSum = 0
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const EndOfFrame& eofr | The object to be copied. |
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
INT_4S run | Frame run number. |
INT_4U frame | Frame number |
INT_4U chktype | Frame checksum scheme. |
INT_4U chksum | File checksum. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
INT_4U- Frame checksum.
Exceptions:
Exception | Description |
None. | |
None. |
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:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
INT_4U- Frame number.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4S- Run number.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- End of frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
SH- End of frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
SH- End of frame structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const EndOfFrame& eofr | Object to be assigned. |
Return value:
const EndOfFrame&- This object.
Exceptions:
Exception | Description |
None. |
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:
Parameter | Description |
FrameReaderBase& in | Input data stream object. |
Return value:
EndOfFrame*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |