Phx::BitVector::InputStream Class Reference

A wrapper to BitVector that provides stream-style input (reading) semantics. More...

#include <PhxBitVector.h>

List of all members.

Public Member Functions
	InputStream (const BitVector *bitVector)
	Construct the InputStream on top of the given bit vector.
const BitVector &	bitVector (void) const
	Returns a reference to the bit vector that this stream was constructed on top of.
Bits	readIndex (void) const
	Gets the position in the bit vector from which the next field will be read.
void	readIndex (Bits readIndex)
	Sets the position in the bit vector to which the next field will be read.
bool	endOfStream (void)
	Returns whether the current readIndex is at or beyond the end of the stream.
InputStream &	operator>> (String &s)
InputStream &	operator>> (double &s)
InputStream &	operator>> (float &s)
InputStream &	operator>> (uint64_t &s)
InputStream &	operator>> (uint32_t &s)
InputStream &	operator>> (uint16_t &s)
InputStream &	operator>> (uint8_t &s)
InputStream &	operator>> (int64_t &s)
InputStream &	operator>> (int32_t &s)
InputStream &	operator>> (int16_t &s)
InputStream &	operator>> (int8_t &s)
InputStream &	operator>> (bool &s)

---

Detailed Description

A wrapper to BitVector that provides stream-style input (reading) 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::InputStream::InputStream (  const BitVector *  bitVector  )  [inline]

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

---

Member Function Documentation

bool Phx::BitVector::InputStream::endOfStream (  void   )  [inline]

Returns whether the current readIndex is at or beyond the end of the stream. Returns: True if the current read index is greater or equal to the number of valid bits in the bit vector.

void Phx::BitVector::InputStream::readIndex (  Bits  readIndex  )  [inline]

Sets the position in the bit vector to which the next field will be read. Parameters: readIndex  The new read index. Note that setting a read index which is beyond the end of the bit vector is legal -- all 'reads' will read 0's. Be sure to check endOfStream().

---

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

• PhxBitVector.h

---