VgEngine::VgBinaryBuffer Class Reference

The VgBinaryBuffer class is used to manipulate binary data. More...

Inheritance diagram for VgEngine::VgBinaryBuffer:

Public Member Functions
	VgBinaryBuffer ()
	Constructor. More...
	VgBinaryBuffer (char *pData, UInt pLength, bool pVgBinaryBufferDoesDelete=true)
	Constructor. More...
virtual	~VgBinaryBuffer ()
	Destructor. More...
virtual UInt	getLength () const
	Retrieves the buffer length. More...
virtual const char *	getData () const
	Retrieves the buffer's data (const version). More...
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...

Protected Attributes
Private *	mPrivate
	Private data for this buffer. More...
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Friends
class	VgObjectBridge

Detailed Description

The VgBinaryBuffer class is used to manipulate binary data.

A VgBinaryBuffer inherits from VgReferenced, so if it's correctly used (see documentation of VgRefPtr) it will be automatically deleted when it's no longer referenced (except if pVgBinaryBufferDoesDelete is false at its creation, as should be the case for static buffers).

Date

25/02/2010

Constructor & Destructor Documentation

VgEngine::VgBinaryBuffer::VgBinaryBuffer

(

)

Constructor.

VgEngine::VgBinaryBuffer::VgBinaryBuffer	(	char *	pData,
		UInt	pLength,
		bool	pVgBinaryBufferDoesDelete = true
	)

Constructor.

Parameters

pData	The buffer (must be allocated using new [] because it will be deleted using delete [], except if pData is a static data, in this case be careful to use the pVgBinaryBufferDoesDelete flag).
pLength	The buffer length in bytes.
pVgBinaryBufferDoesDelete	This flag indicates whether the buffer will delete the data when it's no longer used (default is true).

virtual VgEngine::VgBinaryBuffer::~VgBinaryBuffer ( )

virtual

Destructor.

Member Function Documentation

virtual const char* VgEngine::VgBinaryBuffer::getData ( ) const

virtual

Retrieves the buffer's data (const version).

virtual UInt VgEngine::VgBinaryBuffer::getLength ( ) const

virtual

Retrieves the buffer length.

Friends And Related Function Documentation

friend class VgObjectBridge

friend

Member Data Documentation

Private* VgEngine::VgBinaryBuffer::mPrivate

protected

Private data for this buffer.

---

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

• VgBinaryBuffer.h