Arxx::BufferWriter Class Reference

#include <BufferWriter.h>

Collaboration diagram for Arxx::BufferWriter:

[legend]List of all members.

---

Detailed Description

Implements a convenient input interface for Arxx::Buffer.

Public Member Functions
	BufferWriter (Arxx::Buffer &Buffer, Arxx::Buffer::size_type stPosition=Arxx::Buffer::Marker::END)
	The BufferWriter constructor.
void	vWrite (Arxx::Buffer::size_type stDataLength, Arxx::Buffer::const_pointer Data=0)
	Write a block of data at the writer's position in the buffer.
Arxx::Buffer &	GetBuffer (void)
	Returns the associated Arxx::Buffer object.
const Arxx::Buffer &	GetBuffer (void) const
	Returns the associated Arxx::Buffer object.
Arxx::Buffer::size_type	stGetPosition (void) const
	Returns the marker's position.
void	vSetPosition (Arxx::Buffer::size_type stPosition)
	Sets the marker's position.
Private Attributes
Arxx::Buffer &	m_Buffer
Arxx::Buffer::Marker	m_Marker

---

Constructor & Destructor Documentation

Arxx::BufferWriter::BufferWriter	(	Arxx::Buffer &	Buffer,
		Arxx::Buffer::size_type	stPosition = Arxx::Buffer::Marker::END
	)

The BufferWriter constructor.

Note:

Sets the Buffers IO position to the buffer's length.

---

Member Function Documentation

const Arxx::Buffer & Arxx::BufferWriter::GetBuffer

(

void

)

const

Returns the associated Arxx::Buffer object.

Returns:

A const Arxx::Buffer reference.

Arxx::Buffer & Arxx::BufferWriter::GetBuffer

(

void

)

Returns the associated Arxx::Buffer object.

Returns:

A non-const Arxx::Buffer reference.

Arxx::Buffer::size_type Arxx::BufferWriter::stGetPosition

(

void

)

const

Returns the marker's position.

void Arxx::BufferWriter::vSetPosition

(

Arxx::Buffer::size_type

stPosition

)

Sets the marker's position.

void Arxx::BufferWriter::vWrite	(	Arxx::Buffer::size_type	stDataLength,
		Arxx::Buffer::const_pointer	Data = 0
	)

Write a block of data at the writer's position in the buffer.

Parameters:

	stDataLength	The length of the data block Data
	Data	The data block to insert at the writer's position. May be omitted to insert stDataLength zeroed bytes.

---

Member Data Documentation

Arxx::Buffer& Arxx::BufferWriter::m_Buffer [private]

Arxx::Buffer::Marker Arxx::BufferWriter::m_Marker [private]

---

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

• BufferWriter.h
• BufferWriter.cxx

---