libStatGen Software 1
|
This class allows a user to easily get/set the fields in a GLF header. More...
#include <GlfHeader.h>
Public Member Functions | |
GlfHeader (const GlfHeader &header) | |
Copy Constructor More... | |
GlfHeader & | operator= (const GlfHeader &header) |
Overload operator= to copy the passed in header into this header. More... | |
bool | copy (const GlfHeader &header) |
Copy the passed in header into this header. More... | |
void | resetHeader () |
Clear this header back to the default setting. More... | |
bool | read (IFILE filePtr) |
Read the header from the specified file (file MUST be in the correct position for reading the header). More... | |
bool | write (IFILE filePtr) const |
Write the header to the specified file. More... | |
bool | getHeaderTextString (std::string &text) |
Set the passed in string to the text string stored in this header. More... | |
bool | setHeaderTextString (const std::string &text) |
Set the header to the passed in string. More... | |
This class allows a user to easily get/set the fields in a GLF header.
The GlfHeader contains:
Definition at line 29 of file GlfHeader.h.
GlfHeader::GlfHeader | ( | ) |
Definition at line 25 of file GlfHeader.cpp.
GlfHeader::~GlfHeader | ( | ) |
Definition at line 32 of file GlfHeader.cpp.
GlfHeader::GlfHeader | ( | const GlfHeader & | header | ) |
Copy Constructor
header | glfheader to copy into this one. |
Definition at line 39 of file GlfHeader.cpp.
References copy().
bool GlfHeader::copy | ( | const GlfHeader & | header | ) |
Copy the passed in header into this header.
header | glfheader to copy into this one. |
Definition at line 54 of file GlfHeader.cpp.
References resetHeader().
Referenced by GlfHeader(), and operator=().
bool GlfHeader::getHeaderTextString | ( | std::string & | text | ) |
Set the passed in string to the text string stored in this header.
text | string to populate with the header text string. |
Definition at line 202 of file GlfHeader.cpp.
Overload operator= to copy the passed in header into this header.
header | glfheader to copy into this one. |
Definition at line 47 of file GlfHeader.cpp.
References copy().
bool GlfHeader::read | ( | IFILE | filePtr | ) |
Read the header from the specified file (file MUST be in the correct position for reading the header).
filePtr | file to read from that is in the correct position. |
Definition at line 80 of file GlfHeader.cpp.
References GlfStatus::FAIL_IO, GlfStatus::FAIL_ORDER, ifread(), and InputFile::isOpen().
Referenced by GlfFile::readHeader().
void GlfHeader::resetHeader | ( | ) |
Clear this header back to the default setting.
Definition at line 72 of file GlfHeader.cpp.
Referenced by copy().
bool GlfHeader::setHeaderTextString | ( | const std::string & | text | ) |
Set the header to the passed in string.
text | header text to assign to this header. |
Definition at line 210 of file GlfHeader.cpp.
bool GlfHeader::write | ( | IFILE | filePtr | ) | const |
Write the header to the specified file.
filePtr | file to write to that is in the correct position. |
Definition at line 141 of file GlfHeader.cpp.
References GlfStatus::FAIL_IO, GlfStatus::FAIL_ORDER, ifwrite(), and InputFile::isOpen().
Referenced by GlfFile::writeHeader().