Class Index | Cross Index | Namespace Index |
The File header.
Contained in: FrameCPP::Version_3_4_5
Derived from:
none
Derived by:
none
#include "../../../../../lib/framecpp/src/Version3_4_5/fileheader.hh"
public function member index: |
|||
FileHeader | (const FileHeader& header); | Copy constructor. | |
FileHeader | (Input& in); | Input constructor. | |
virtual | ~FileHeader | (); | Destructor. |
bool | byteSwapNeeded | () const; | See whether file input does byte swapping |
inline const char* | getAscii | () const; | get ASCII string |
inline INT_2U | getDataFormatVersion | () const; | Get frame file data format version |
inline Dictionary* | getDictionary | (); | Get a dictionary for this file header |
inline const char* | getIdentifier | () const; | Get "IGWD" identifier from the frame file header |
inline const unsigned char* | getInt2Sample | () const; | Get sample two byte integer |
inline INT_2U | getInt2Size | () const; | Get two byte integer size |
inline const unsigned char* | getInt4Sample | () const; | Get sample four byte integer |
inline INT_2U | getInt4Size | () const; | Get four byte integer size |
inline const unsigned char* | getInt8Sample | () const; | Get sample eight byte integer |
inline INT_2U | getInt8Size | () const; | Get eight byte integer size |
inline INT_2U | getLibMinorVersion | () const; | Get library minor version field |
inline const unsigned char* | getReal4Sample | () const; | Get sample four byte real |
inline INT_2U | getReal4Size | () const; | Get four byte real size |
inline const unsigned char* | getReal8Sample | () const; | Get sample eight byte real |
inline INT_2U | getReal8Size | () const; | Get eight byte real size |
const FileHeader& | operator = | (const FileHeader& header); | Assignment Operator. |
static FileHeader* | read | (Input& in); | Read new file header from the input file |
inline bool | readINT2S | (Input& in, INT_2S* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readINT2U | (Input& in, INT_2U* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readINT4S | (Input& in, INT_4S* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readINT4U | (Input& in, INT_4U* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readINT8S | (Input& in, INT_8S* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readINT8U | (Input& in, INT_8U* v, unsigned int n = 1); | Read an integer, doing byte swapping if necessary |
inline bool | readREAL4 | (Input& in, REAL_4* v, unsigned int n = 1); | Read a real, doing byte swapping if necessary |
inline bool | readREAL8 | (Input& in, REAL_8* v, unsigned int n = 1); | Read a real, doing byte swapping if necessary |
static void | writeLocal | (Output& out, int version); | Writes specified frame data format version file header to output. |
private function member index: |
|||
FileHeader | (const char* Header); | ||
void | (FileHeader::*mInt2UReader); | ||
void | checkInt2 | (); | |
void | checkInt4 | (); | |
void | checkInt8 | (); | |
void | readInt2S_B | (Input& in, INT_2S* v, unsigned int n); | |
void | readInt2S_L | (Input& in, INT_2S* v, unsigned int n); | |
void | readInt2U_B | (Input& in, INT_2U* v, unsigned int n); | |
void | readInt2U_L | (Input& in, INT_2U* v, unsigned int n); | |
void | readInt4S_2B | (Input& in, INT_4S* v, unsigned int n); | |
void | readInt4S_2L | (Input& in, INT_4S* v, unsigned int n); | |
void | readInt4S_4B | (Input& in, INT_4S* v, unsigned int n); | |
void | readInt4S_4L | (Input& in, INT_4S* v, unsigned int n); | |
void | readInt4U_2B | (Input& in, INT_4U* v, unsigned int n); | |
void | readInt4U_2L | (Input& in, INT_4U* v, unsigned int n); | |
void | readInt4U_4B | (Input& in, INT_4U* v, unsigned int n); | |
void | readInt4U_4L | (Input& in, INT_4U* v, unsigned int n); | |
void | readInt8S_4B | (Input& in, INT_8S* v, unsigned int n); | |
void | readInt8S_4L | (Input& in, INT_8S* v, unsigned int n); | |
void | readInt8S_8B | (Input& in, INT_8S* v, unsigned int n); | |
void | readInt8S_8L | (Input& in, INT_8S* v, unsigned int n); | |
void | readInt8U_4B | (Input& in, INT_8U* v, unsigned int n); | |
void | readInt8U_4L | (Input& in, INT_8U* v, unsigned int n); | |
void | readInt8U_8B | (Input& in, INT_8U* v, unsigned int n); | |
void | readInt8U_8L | (Input& in, INT_8U* v, unsigned int n); | |
void | readReal4_B | (Input& in, REAL_4* v, unsigned int n); | |
void | readReal4_L | (Input& in, REAL_4* v, unsigned int n); | |
void | readReal8_B | (Input& in, REAL_8* v, unsigned int n); | |
void | readReal8_L | (Input& in, REAL_8* v, unsigned int n); | |
void | update | (); | |
The FileHeader class also provides the ability to read from a frame file.
Data conversions (such as byte-ordering) are taken care of by this class.
Parameters:
Parameter | Description |
const FileHeader& header | Object to be copied. |
This constructs a FileHeader by reading it from an Input object.
Parameters:
Parameter | Description |
Input& in | Input data stream object. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
read_failure | Read failed. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Exceptions:
Exception | Description |
None. | |
None |
Parameters:
Parameter | Description |
const FileHeader& header | Object to be assigned. |
Return value:
const FileHeader&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
read_failure | Read failed. |
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
out (Output&) | output frame file |
out (version) | data format version |