#include <itpp/base/binfile.h>
Inheritance diagram for itpp::bofstream:
Public Types | |
enum | endian { l_endian, b_endian } |
Definition of the endian data type. More... | |
Public Member Functions | |
bofstream (const std::string &name, endian e=b_endian) | |
Class constructor that opens a file and sets the endianity. | |
bofstream () | |
Class Constructor. | |
~bofstream () | |
Class Destructor. | |
void | open (const std::string &name, endian e=b_endian) |
Open a file for writing and set the endianity. | |
bofstream & | operator<< (char a) |
Writes a char variable to the binary output file. | |
bofstream & | operator<< (const class bin &a) |
Writes a bin variable to the binary output file. | |
bofstream & | operator<< (int a) |
Writes an int variable to the binary output file. | |
bofstream & | operator<< (unsigned int a) |
Writes an unsigned int variable to the binary output file. | |
bofstream & | operator<< (short a) |
Writes a short variable to the binary output file. | |
bofstream & | operator<< (unsigned short a) |
Writes an unsigned short variable to the binary output file. | |
bofstream & | operator<< (float a) |
Writes a float variable to the binary output file. | |
bofstream & | operator<< (double a) |
Writes a double variable to the binary output file. | |
bofstream & | operator<< (long int a) |
Writes a long int variable to the binary output file. | |
bofstream & | operator<< (unsigned long int a) |
Writes a unsigned long int variable to the binary output file. | |
bofstream & | operator<< (const char *a) |
ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!! | |
bofstream & | operator<< (const std::string &a) |
Writes a string variable to the binary output file. | |
endian | get_endianity () const |
Returns the endianity of the class (l_endian or b_endian ). | |
endian | get_native_endianity () const |
Returns the native endianity for this computer architecture (l_endian or b_endian ). | |
void | set_endianity (endian e) |
Set the endianity for this class. | |
void | set_native_endianity () |
Set the endianity of this class to the native endianity for this computer architecture. | |
Protected Attributes | |
endian | endianity |
The endianity used by this class. | |
endian | native_endianity |
The native endianity for this computer architecture. |
Definition at line 108 of file binfile.h.
enum itpp::bfstream_base::endian [inherited] |
Definition of the endian data type.
The Endian defines the order in which multibyte numbers are stored in the file. The two orders are called "Little Endian" (l_endian
) and "Big Endian" (b_endian
).
"Little Endian" means that the low-order byte of the number is stored at the lowest adress (i.e. the little end comes first). "Big Endian" means that the high-order byte of the number is stored in memory at the highest address (i.e. the big end comes first)
itpp::bofstream::bofstream | ( | const std::string & | name, | |
endian | e = b_endian | |||
) |
Class constructor that opens a file and sets the endianity.
name | The name of the file to open | |
e | Defines the endianity of the class. Possible values are l_endian for "Little Endian" or b_endian for "Big Endian". The default value is b_endian . |
Definition at line 76 of file binfile.cpp.
itpp::bofstream::bofstream | ( | ) |
itpp::bofstream::~bofstream | ( | ) | [inline] |
void itpp::bofstream::open | ( | const std::string & | name, | |
endian | e = b_endian | |||
) |
Open a file for writing and set the endianity.
name | The name of the file to open | |
e | Defines the endianity of the class (default value is b_endian ) |
Definition at line 86 of file binfile.cpp.
References itpp::bfstream_base::endianity.
bofstream & itpp::bofstream::operator<< | ( | char | a | ) |
bofstream & itpp::bofstream::operator<< | ( | int | a | ) |
Writes an int
variable to the binary output file.
Definition at line 186 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | unsigned int | a | ) |
Writes an unsigned
int
variable to the binary output file.
Definition at line 201 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | short | a | ) |
Writes a short
variable to the binary output file.
Definition at line 104 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | unsigned short | a | ) |
Writes an unsigned
short variable to the binary output file.
Definition at line 118 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | float | a | ) |
Writes a float
variable to the binary output file.
Definition at line 131 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | double | a | ) |
Writes a double
variable to the binary output file.
Definition at line 146 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | long int | a | ) |
Writes a long
int
variable to the binary output file.
Definition at line 216 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | unsigned long int | a | ) |
Writes a unsigned
long
int
variable to the binary output file.
Definition at line 231 of file binfile.cpp.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
bofstream & itpp::bofstream::operator<< | ( | const char * | a | ) |
bofstream & itpp::bofstream::operator<< | ( | const std::string & | a | ) |
endian itpp::bfstream_base::get_endianity | ( | ) | const [inline, inherited] |
Returns the endianity of the class (l_endian
or b_endian
).
Definition at line 78 of file binfile.h.
References itpp::bfstream_base::endianity.
endian itpp::bfstream_base::get_native_endianity | ( | ) | const [inline, inherited] |
Returns the native endianity for this computer architecture (l_endian
or b_endian
).
Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.
Definition at line 85 of file binfile.h.
References itpp::bfstream_base::native_endianity.
Referenced by itpp::it_file::write_data_header().
void itpp::bfstream_base::set_endianity | ( | endian | e | ) | [inline, inherited] |
Set the endianity for this class.
Definition at line 90 of file binfile.h.
References itpp::bfstream_base::endianity.
Referenced by itpp::it_ifile::read_data_header(), and itpp::it_file::write_data_header_here().
void itpp::bfstream_base::set_native_endianity | ( | ) | [inline, inherited] |
Set the endianity of this class to the native endianity for this computer architecture.
Definition at line 95 of file binfile.h.
References itpp::bfstream_base::endianity, and itpp::bfstream_base::native_endianity.
endian itpp::bfstream_base::endianity [protected, inherited] |
The endianity used by this class.
Definition at line 99 of file binfile.h.
Referenced by itpp::bfstream_base::bfstream_base(), itpp::bfstream_base::get_endianity(), itpp::bfstream::open(), itpp::bifstream::open(), open(), itpp::bfstream::open_readonly(), itpp::bfstream::operator<<(), operator<<(), itpp::bfstream::operator>>(), itpp::bifstream::operator>>(), itpp::it_ifile::read_data_header(), itpp::bfstream_base::set_endianity(), itpp::bfstream_base::set_native_endianity(), and itpp::it_file::write_data_header_here().
endian itpp::bfstream_base::native_endianity [protected, inherited] |
The native endianity for this computer architecture.
Definition at line 101 of file binfile.h.
Referenced by itpp::bfstream_base::bfstream_base(), itpp::bfstream_base::get_native_endianity(), itpp::bfstream::operator<<(), operator<<(), itpp::bfstream::operator>>(), itpp::bifstream::operator>>(), and itpp::bfstream_base::set_native_endianity().
Generated on Fri Jun 8 02:09:02 2007 for IT++ by Doxygen 1.5.2