Phx::BitVector::OutputStream Class Reference

A wrapper to BitVector that provides stream-style output (writing) semantics. More...

#include <PhxBitVector.h>

List of all members.

Public Member Functions
	OutputStream (BitVector *bitVector)
	Construct the OutputStream on top of the given bit vector.
BitVector &	bitVector (void)
	Returns a reference to the bit vector that this stream was constructed on top of.
Bits	writeIndex (void) const
	Gets the position in the bit vector to which the next field will be written.
void	writeIndex (Bits writeIndex)
	Sets the position in the bit vector to which the next field will be written.
OutputStream &	operator<< (const String &s)
OutputStream &	operator<< (double s)
OutputStream &	operator<< (float s)
OutputStream &	operator<< (uint64_t s)
OutputStream &	operator<< (uint32_t s)
OutputStream &	operator<< (uint16_t s)
OutputStream &	operator<< (uint8_t s)
OutputStream &	operator<< (int64_t s)
OutputStream &	operator<< (int32_t s)
OutputStream &	operator<< (int16_t s)
OutputStream &	operator<< (int8_t s)
OutputStream &	operator<< (bool s)

---

Detailed Description

A wrapper to BitVector that provides stream-style output (writing) semantics.

Note that this stream is only valid for as long as the pointer to the bit vector supplied to its constructor is valid. The responsibility for the memory pointed to is the client's.

---

Constructor & Destructor Documentation

Phx::BitVector::OutputStream::OutputStream (  BitVector *  bitVector  )  [inline]

Construct the OutputStream on top of the given bit vector. Parameters: bitVector  The BitVector to write data to. Exceptions: RangeException  thrown if bitVector is 0.

---

Member Function Documentation

void Phx::BitVector::OutputStream::writeIndex (  Bits  writeIndex  )  [inline]

Sets the position in the bit vector to which the next field will be written. Parameters: writeIndex  The new write index. Note that setting a write index which is beyond the end of the bit vector is legal -- all of the intervening bits will simply be set to 0.

---

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

• PhxBitVector.h

---