IT++ Logo

itpp::bofstream Class Reference
[IT++ File Format]

Binary Outfile Class. More...

#include <itpp/base/binfile.h>

Inheritance diagram for itpp::bofstream:
itpp::bfstream_base

List of all members.

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.
bofstreamoperator<< (char a)
 Writes a signed char variable to the binary output file.
bofstreamoperator<< (unsigned char a)
 Writes an unsigned char variable to the binary output file.
bofstreamoperator<< (int16_t a)
 Writes a 16-bit signed integer variable to the binary output file.
bofstreamoperator<< (uint16_t a)
 Writes a 16-bit unsigned integer variable to the binary output file.
bofstreamoperator<< (int32_t a)
 Writes a 32-bit signed integer variable to the binary output file.
bofstreamoperator<< (uint32_t a)
 Writes a 32-bit unsigned integer variable to the binary output file.
bofstreamoperator<< (int64_t a)
 Writes a 64-bit signed integer variable to the binary output file.
bofstreamoperator<< (uint64_t a)
 Writes a 64-bit unsigned ingeger variable to the binary output file.
bofstreamoperator<< (float a)
 Writes a float variable to the binary output file.
bofstreamoperator<< (double a)
 Writes a double variable to the binary output file.
bofstreamoperator<< (const char *a)
 Writes a char* string to the binary output file.
bofstreamoperator<< (const std::string &a)
 Writes a string variable to the binary output file.
endian get_endianity () const
 Returns the endianity of the class.
endian get_native_endianity () const
 Returns the native endianity for this computer architecture.
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

bool switch_endianity
 Indicates if the endianity of the processed data needs to be changed.
endian native_endianity
 The native endianity for this computer architecture.

Detailed Description

Binary Outfile Class.

Definition at line 129 of file binfile.h.


Member Enumeration Documentation

enum itpp::bfstream_base::endian [inherited]

Definition of the endian data type.

The Endianness 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 address (i.e. the little end comes first). "Big Endian" means that the high-order byte of the number is stored in memory at the lowest address (i.e. the big end comes first)

Definition at line 69 of file binfile.h.


Constructor & Destructor Documentation

itpp::bofstream::bofstream ( const std::string &  name,
endian  e = b_endian 
)

Class constructor that opens a file and sets the endianity.

Parameters:
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 99 of file binfile.cpp.


Member Function Documentation

void itpp::bofstream::open ( const std::string &  name,
endian  e = b_endian 
)

Open a file for writing and set the endianity.

Parameters:
name The name of the file to open
e Defines the endianity of the class (default value is b_endian )

Definition at line 104 of file binfile.cpp.

References itpp::bfstream_base::native_endianity, and itpp::bfstream_base::switch_endianity.

endian itpp::bfstream_base::get_native_endianity (  )  const [inline, inherited]

Returns the native endianity for this computer architecture.

Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.

Definition at line 100 of file binfile.h.

References itpp::bfstream_base::native_endianity.

Referenced by itpp::it_file_old::write_data_header().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
SourceForge Logo

Generated on Sun Dec 20 07:06:21 2009 for IT++ by Doxygen 1.6.1