Class Index | Cross Index | Namespace Index |
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. |
This creates an EndOfFile object with the following properties:
- nFrames = 0
- nBytes = 0
- chkType = 0
- chkSum = 0
- seekTOC = 0
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const EndOfFile& eof | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
INT_4U frames | The number of frame in the file. |
INT_4U bytes | The number of bytes in this file. |
INT_4U chktype | Checksum scheme: 0 = none, 1 = CRC. |
INT_4U chksum | File checksum. |
INT_4U seekTOC | Bytes to back up to the beginning of the TOC. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Return value:
INT_4U- 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. |
This is zero if it is not computed.
Return value:
INT_4U- Number of bytes.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4U- Number of frames.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
SH- Structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
INT_4U- TOC offset.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const EndOfFile& eof | Object to assign. |
Return value:
const EndOfFile&- 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 |
Input& in | Input data stream object. |
Return value:
EndOfFile*- 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 | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failed. |