Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::FileHeader

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();
 

Description:

This class reresents the 40-byte file header for a frame file. It contains information about how data is formatted within the file, as well as information about the machine used to write the file.

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.


Function Member Descriptions:


FrameCPP::Version_3_4_5::FileHeader::FileHeader - Copy constructor.


FileHeader(const FileHeader& header);

Parameters:
ParameterDescription
const FileHeader& headerObject to be copied.



FrameCPP::Version_3_4_5::FileHeader::FileHeader - Input constructor.


FileHeader(Input& in);
This constructs a FileHeader by reading it from an Input object.

Parameters:
ParameterDescription
Input& inInput data stream object.

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



FrameCPP::Version_3_4_5::FileHeader::FileHeader


FileHeader(const char* Header);



FrameCPP::Version_3_4_5::FileHeader::void


void(FileHeader::*mInt2UReader);



FrameCPP::Version_3_4_5::FileHeader::~FileHeader - Destructor.


virtual ~FileHeader();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::byteSwapNeeded - See whether file input does byte swapping


bool byteSwapNeeded() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::checkInt2


void checkInt2();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::checkInt4


void checkInt4();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::checkInt8


void checkInt8();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::getAscii - get ASCII string


inline const char* getAscii() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getDataFormatVersion - Get frame file data format version


inline INT_2U getDataFormatVersion() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getDictionary - Get a dictionary for this file header


inline Dictionary* getDictionary();

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::getIdentifier - Get "IGWD" identifier from the frame file header


inline const char* getIdentifier() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt2Sample - Get sample two byte integer


inline const unsigned char* getInt2Sample() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt2Size - Get two byte integer size


inline INT_2U getInt2Size() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt4Sample - Get sample four byte integer


inline const unsigned char* getInt4Sample() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt4Size - Get four byte integer size


inline INT_2U getInt4Size() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt8Sample - Get sample eight byte integer


inline const unsigned char* getInt8Sample() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getInt8Size - Get eight byte integer size


inline INT_2U getInt8Size() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getLibMinorVersion - Get library minor version field


inline INT_2U getLibMinorVersion() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getReal4Sample - Get sample four byte real


inline const unsigned char* getReal4Sample() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getReal4Size - Get four byte real size


inline INT_2U getReal4Size() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getReal8Sample - Get sample eight byte real


inline const unsigned char* getReal8Sample() const;

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FileHeader::getReal8Size - Get eight byte real size


inline INT_2U getReal8Size() const;

Exceptions:
ExceptionDescription
None.
None



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


const FileHeader& operator =(const FileHeader& header);

Parameters:
ParameterDescription
const FileHeader& headerObject to be assigned.

Return value:
const FileHeader&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::FileHeader::read - Read new file header from the input file


static FileHeader* read(Input& in);

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



FrameCPP::Version_3_4_5::FileHeader::readINT2S - Read an integer, doing byte swapping if necessary


inline bool readINT2S(Input& in, INT_2S* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readINT2U - Read an integer, doing byte swapping if necessary


inline bool readINT2U(Input& in, INT_2U* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readINT4S - Read an integer, doing byte swapping if necessary


inline bool readINT4S(Input& in, INT_4S* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readINT4U - Read an integer, doing byte swapping if necessary


inline bool readINT4U(Input& in, INT_4U* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readINT8S - Read an integer, doing byte swapping if necessary


inline bool readINT8S(Input& in, INT_8S* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readINT8U - Read an integer, doing byte swapping if necessary


inline bool readINT8U(Input& in, INT_8U* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt2S_B


void readInt2S_B(Input& in, INT_2S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt2S_L


void readInt2S_L(Input& in, INT_2S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt2U_B


void readInt2U_B(Input& in, INT_2U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt2U_L


void readInt2U_L(Input& in, INT_2U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4S_2B


void readInt4S_2B(Input& in, INT_4S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4S_2L


void readInt4S_2L(Input& in, INT_4S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4S_4B


void readInt4S_4B(Input& in, INT_4S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4S_4L


void readInt4S_4L(Input& in, INT_4S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4U_2B


void readInt4U_2B(Input& in, INT_4U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4U_2L


void readInt4U_2L(Input& in, INT_4U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4U_4B


void readInt4U_4B(Input& in, INT_4U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt4U_4L


void readInt4U_4L(Input& in, INT_4U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8S_4B


void readInt8S_4B(Input& in, INT_8S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8S_4L


void readInt8S_4L(Input& in, INT_8S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8S_8B


void readInt8S_8B(Input& in, INT_8S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8S_8L


void readInt8S_8L(Input& in, INT_8S* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8U_4B


void readInt8U_4B(Input& in, INT_8U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8U_4L


void readInt8U_4L(Input& in, INT_8U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8U_8B


void readInt8U_8B(Input& in, INT_8U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readInt8U_8L


void readInt8U_8L(Input& in, INT_8U* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readREAL4 - Read a real, doing byte swapping if necessary


inline bool readREAL4(Input& in, REAL_4* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readREAL8 - Read a real, doing byte swapping if necessary


inline bool readREAL8(Input& in, REAL_8* v, unsigned int n = 1);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readReal4_B


void readReal4_B(Input& in, REAL_4* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readReal4_L


void readReal4_L(Input& in, REAL_4* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readReal8_B


void readReal8_B(Input& in, REAL_8* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::readReal8_L


void readReal8_L(Input& in, REAL_8* v, unsigned int n);

Exceptions:
ExceptionDescription
read_failureRead failed.



FrameCPP::Version_3_4_5::FileHeader::update


void update();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FileHeader::writeLocal - Writes specified frame data format version file header to output.


static void writeLocal(Output& out, int version);

Parameters:
ParameterDescription
out (Output&)output frame file
out (version)data format version



Variable Member Descriptions:


FrameCPP::Version_3_4_5::FileHeader::mData - Frame file header data.

unsigned char* mData;