VisualObjectData allows incremental data load of visual objects. More...

#include <VisualObjectData.h>

Public Member Functions
	VisualObjectData ()
	The constructor.
	VisualObjectData (const VisualItemIdentifier &anIdentifier)
	Another constructor.
	~VisualObjectData ()
	The destructor.
	VisualObjectData (const VisualObjectData &other)
	Copy constructor.
VisualObjectData &	operator= (const VisualObjectData &other)
	Assignment operator.
bool	operator< (const VisualObjectData &other) const
	Less than operator.
bool	operator> (const VisualObjectData &other) const
	Greater than operator.
bool	operator== (const VisualObjectData &other) const
	Equality operator.
bool	operator!= (const VisualObjectData &other) const
	Inequality operator.
const VisualItemIdentifier	getIdentifier (void) const
	Returns the identifier of the object item.
bool	addData (void *dataPtr, size_t dataSize)
	Adds data to the object.
void	freeData (void)
	Deallocates the data if there has been data allocated.
size_t	getDataSizeUsed (void)
	Returns the number of bytes currently used by the internal data buffer.
size_t	getDataSizeDeclared (void)
	Returns the declared size in bytes of the object.
void	setDataSizeDeclared (const size_t &aDataSizeDeclared)
	Sets the declared size in bytes of the object.
bool	dataSizeDeclaredHasBeenSet (void)
	Returns whether the declared data size has been set yet.
void	release (void)
	Decrements the refCount so that the VisualObjectData is deleted the next time the enclosing VisualObject is deleted.
size_t	getRefCount (void)
	Returns the ref count of the object.
bool	isDownloading (void)
	Answers the question whether VisualObjectData is currently in VisualDownloadQueue and downloading data.
void	setIsDownloading (bool isDownloadingBoolean)
	Sets the boolean flag to indicate that the VisualObjectData is beginning to oder ending to download data.
Private Member Functions
void	copyObject (const VisualObjectData &other)
	Copy method for assignment operator and copy constructor.
Private Attributes
char *	data
	Each VisualObjectData can contain arbitrary data.
size_t	dataSizeUsed
	The number of bytes used for data.
size_t	dataSizeDeclared
	The number of bytes declared.
bool	dataSizeDeclaredHasBeenSetBool
	Flag denotes whether the declared data size has been set yet.
VisualItemIdentifier *	itemIdentifier
	Each VisualObjectData contains a unique identifier.
size_t	dataSizeAllocated
	The number of bytes allocated for potential data use.
size_t	refCount
	The internal refCount.
bool	isDownloadingBool
	True if VisualObjectData is currently in VisualDownloadQueue and downloading data.
Friends
class	VisualObject

Detailed Description

VisualObjectData allows incremental data load of visual objects.

Constructor & Destructor Documentation

VisualObjectData::VisualObjectData ( )

The constructor.

VisualObjectData::VisualObjectData ( const VisualItemIdentifier & anIdentifier )

Another constructor.

Parameters:

anIdentifier Identifier of the object.

VisualObjectData::~VisualObjectData ( )

The destructor.

VisualObjectData::VisualObjectData ( const VisualObjectData & other )

Copy constructor.

Parameters:

other Reference to another VisualObjectData.

Member Function Documentation

bool VisualObjectData::addData	(	void *	dataPtr,
		size_t	dataSize
	)

Adds data to the object.

Parameters:

dataPtr	Pointer to data.
dataSize	The number of bytes of the dataPtr.

Returns:: True on success, false on failure.

Remarks:: The data is copied.

void VisualObjectData::copyObject ( const VisualObjectData & other ) [private]

Copy method for assignment operator and copy constructor.

Parameters:

other Another VisualObjectData.

bool VisualObjectData::dataSizeDeclaredHasBeenSet ( void )

Returns whether the declared data size has been set yet.

Returns:: Boolean flag answers the question whether the declared data size has been set yet.

void VisualObjectData::freeData ( void )

Deallocates the data if there has been data allocated.

size_t VisualObjectData::getDataSizeDeclared ( void )

Returns the declared size in bytes of the object.

Returns:: The declared size in bytes of the object.

Remarks:: The size can be declared by a remote header file before the actual data has been fetched.

size_t VisualObjectData::getDataSizeUsed ( void )

Returns the number of bytes currently used by the internal data buffer.

Returns:: The number of bytes currently used by the internal data buffer.

const VisualItemIdentifier VisualObjectData::getIdentifier ( void ) const

Returns the identifier of the object item.

Returns:: The identifier of the object item.

Remarks:: Fully implemeted by VisualObjectData class.

size_t VisualObjectData::getRefCount ( void )

Returns the ref count of the object.

Returns:: The ref count of the object.

bool VisualObjectData::isDownloading ( void )

Answers the question whether VisualObjectData is currently in VisualDownloadQueue and downloading data.

Returns:: True if VisualObjectData is currently in VisualDownloadQueue and downloading data.

bool VisualObjectData::operator!= ( const VisualObjectData & other ) const

Inequality operator.

Parameters:

other Another VisualObjectData.

bool VisualObjectData::operator< ( const VisualObjectData & other ) const

Less than operator.

Parameters:

other Another VisualObjectData.

Remarks:: The less than operator is used by std::map for find() and sorting (if VisualObjectData is used as key_type).

VisualObjectData & VisualObjectData::operator= ( const VisualObjectData & other )

Assignment operator.

Parameters:

other Reference to another VisualObjectData.

bool VisualObjectData::operator== ( const VisualObjectData & other ) const

Equality operator.

Parameters:

other Another VisualObjectData.

bool VisualObjectData::operator> ( const VisualObjectData & other ) const

Greater than operator.

Parameters:

other Another VisualObjectData.

Remarks:: The less than operator is used by std::map for find() and sorting (if VisualObjectData is used as key_type).

void VisualObjectData::release ( void )

Decrements the refCount so that the VisualObjectData is deleted the next time the enclosing VisualObject is deleted.

void VisualObjectData::setDataSizeDeclared ( const size_t & aDataSizeDeclared )

Sets the declared size in bytes of the object.

Parameters:

aDataSizeDeclared The number of bytes declared.

Remarks:: The size can be declared by a remote header file before the actual data has been fetched.

void VisualObjectData::setIsDownloading ( bool isDownloadingBoolean )

Sets the boolean flag to indicate that the VisualObjectData is beginning to oder ending to download data.

Parameters:

isDownloadingBoolean True if VisualObjectData starting with download, false if not.

Friends And Related Function Documentation

friend class VisualObject [friend]

Member Data Documentation

char* VizKit::VisualObjectData::data [private]

Each VisualObjectData can contain arbitrary data.

Remarks:: The strategic memory allocation for the data is controlled internally when receiving addData() call;

size_t VizKit::VisualObjectData::dataSizeAllocated [private]

The number of bytes allocated for potential data use.

This number reflects the number of bytes allocated in advance.

size_t VizKit::VisualObjectData::dataSizeDeclared [private]

The number of bytes declared.

This number answers the question how many bytes are expected to be used by this object according to a declaration, found e.g. in a remote header file.

bool VizKit::VisualObjectData::dataSizeDeclaredHasBeenSetBool [private]

Flag denotes whether the declared data size has been set yet.

size_t VizKit::VisualObjectData::dataSizeUsed [private]

The number of bytes used for data.

This number reflects the number of valid bytes copied.

bool VizKit::VisualObjectData::isDownloadingBool [private]

True if VisualObjectData is currently in VisualDownloadQueue and downloading data.

Returns:: True if VisualObjectData is currently in VisualDownloadQueue and downloading data.

VisualItemIdentifier* VizKit::VisualObjectData::itemIdentifier [private]

Each VisualObjectData contains a unique identifier.

size_t VizKit::VisualObjectData::refCount [private]

The internal refCount.

Pointers to VisualObjectData might be shared, in concurrent use at different places, so that the final destruction and memory ownership is not determined. Deleting a VisualObject therefore decrements the refCount of VisualObjectData.

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

vizkit/source/VisualObjectData.h
vizkit/source/VisualObjectData.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation