QDP++
QDP::BinaryBufferWriter Class Reference

Binary buffer output class. More...

#include <qdp_io.h>

Inheritance diagram for QDP::BinaryBufferWriter:
QDP::BinaryWriter

Public Member Functions

 BinaryBufferWriter ()
 BinaryBufferWriter (const std::string &s)
 Construct from a string.
 ~BinaryBufferWriter ()
 Closes the buffer.
void open (const std::string &s)
 Construct from a string.
std::string str () const
 Return entire buffer as a string.
std::string strPrimaryNode () const
 Return entire buffer as a string.
void flush ()
 Flushes the buffer.
void clear ()
 Clear the buffer.
Public Member Functions inherited from QDP::BinaryWriter
 BinaryWriter ()
 Default constructor.
virtual ~BinaryWriter ()
virtual void writeArrayPrimaryNode (const char *output, size_t nbytes, size_t nmemb)
 Write data on the primary node only.
virtual void writeArray (const char *output, size_t nbytes, size_t nmemb)
 Write data from the primary node.
virtual void writeDesc (const std::string &output)
 Writes a fixed length of characters like an array.
virtual void write (const std::string &output)
virtual void write (const char *output)
virtual void write (const char &output)
virtual void write (const int &output)
virtual void write (const unsigned int &output)
virtual void write (const short int &output)
virtual void write (const unsigned short int &output)
virtual void write (const long int &output)
virtual void write (const unsigned long int &output)
virtual void write (const long long int &output)
virtual void write (const float &output)
virtual void write (const double &output)
virtual void write (const bool &output)
virtual bool fail ()
 Checks status of the previous IO operation.
virtual QDPUtil::n_uint32_t getChecksum ()
 Get the current checksum.
virtual void resetChecksum ()
 Reset the current checksum.
virtual pos_type currentPosition ()
 Current position.
virtual void seek (pos_type off)
 Set the current position.
virtual void seekBegin (off_type off)
 Set the position relative from the start.
virtual void seekRelative (off_type off)
 Set the position relative to the current position.
virtual void seekEnd (off_type off)
 Set the position relative from the end.
virtual void rewind ()
 Rewind object to the beginning.

Protected Member Functions

QDPUtil::n_uint32_tinternalChecksum ()
 Get the current checksum to modify.
std::ostream & getOstream ()
 Get the internal output stream.
Protected Member Functions inherited from QDP::BinaryWriter
template<typename T>
void writePrimitive (const T &output)
 The universal data-writer.

Additional Inherited Members

Public Types inherited from QDP::BinaryWriter
typedef std::ostream::pos_type pos_type
typedef std::ostream::off_type off_type

Detailed Description

Binary buffer output class.

This class is used to write data to a binary buffer. The data in the buffer is big-endian. If the host nachine is little-endian, the data is byte-swapped. Output is done from the primary node only.

Buffers need to be opened before any of the write methods are used

The write methods are also wrapped by externally defined functions and << operators,

Definition at line 1389 of file qdp_io.h.

Constructor & Destructor Documentation

◆ BinaryBufferWriter() [1/2]

QDP::BinaryBufferWriter::BinaryBufferWriter ( )

Definition at line 1347 of file qdp_io.cc.

◆ BinaryBufferWriter() [2/2]

QDP::BinaryBufferWriter::BinaryBufferWriter ( const std::string & s)
explicit

Construct from a string.

Definition at line 1350 of file qdp_io.cc.

References open().

◆ ~BinaryBufferWriter()

QDP::BinaryBufferWriter::~BinaryBufferWriter ( )

Closes the buffer.

Definition at line 1352 of file qdp_io.cc.

Member Function Documentation

◆ clear()

void QDP::BinaryBufferWriter::clear ( )

Clear the buffer.

Definition at line 1384 of file qdp_io.cc.

References QDP::Layout::primaryNode().

◆ flush()

void QDP::BinaryBufferWriter::flush ( )
inlinevirtual

Flushes the buffer.

Implements QDP::BinaryWriter.

Definition at line 1410 of file qdp_io.h.

◆ getOstream()

std::ostream & QDP::BinaryBufferWriter::getOstream ( )
inlineprotectedvirtual

Get the internal output stream.

Implements QDP::BinaryWriter.

Definition at line 1420 of file qdp_io.h.

◆ internalChecksum()

QDPUtil::n_uint32_t & QDP::BinaryBufferWriter::internalChecksum ( )
inlineprotectedvirtual

Get the current checksum to modify.

Implements QDP::BinaryWriter.

Definition at line 1417 of file qdp_io.h.

◆ open()

void QDP::BinaryBufferWriter::open ( const std::string & s)

Construct from a string.

Definition at line 1354 of file qdp_io.cc.

References QDP::Layout::primaryNode().

Referenced by BinaryBufferWriter().

◆ str()

◆ strPrimaryNode()

std::string QDP::BinaryBufferWriter::strPrimaryNode ( ) const

Return entire buffer as a string.

Definition at line 1361 of file qdp_io.cc.

References QDP::Layout::primaryNode().


The documentation for this class was generated from the following files: