iso::visual::AttributeData Class Reference

#include <iso_visual_attribute_data.h>

Inherited by iso::visual::TypedAttributeData< AttributeType >.

Inheritance diagram for iso::visual::AttributeData:

[legend]List of all members.

Public Member Functions
template<typename AttributeType>
	AttributeData (const base::String &pAttributeName, int pAttributeCount, int pAttributeDim, AttributeType *pValues)
	create attribute data
	AttributeData ()
	create attribute data
	AttributeData (const AttributeData &pAttributeData)
	create attribute data
	AttributeData (const base::String &pAttributeName, const AttributeData &pAttributeData)
	create attribute data
virtual	~AttributeData ()
	destructor
virtual const AttributeData &	operator= (const AttributeData &pAttributeData)=0 throw (VisualException)
	create copy of attribute data
template<typename AttributeType>
	operator AttributeType * () const throw (VisualException)
	return attributes
template<typename AttributeType>
	operator AttributeType * () throw (VisualException)
	return attributes
virtual AttributeData *	copy () const=0
	create a new copy of attribute data
virtual AttributeData *	copy (const base::String &pAttributeName) const=0
	create a new copy of attribute data
const base::String &	attributeName () const
	return attribute name
const std::type_info *	attributeType () const
	return attribute type
int	attributeCount () const
	return attribute count
int	attributeDim () const
	return attribute dimension
template<typename AttributeType>
const AttributeType *	attributes () const throw (VisualException)
	return attributes
template<typename AttributeType>
AttributeType *	attributes () throw (VisualException)
	return attributes
template<typename AttributeType>
const AttributeType *	operator[] (unsigned int pIndex) const throw (VisualException)
	access array value
template<typename AttributeType>
AttributeType *	operator[] (unsigned int pIndex) throw (VisualException)
	access array value
virtual GLData *	createGL (GLBufferType pType, GLBufferUsage pUsage)=0 throw (VisualException)
virtual GLData *	createGL (const math::Vector< int > &pSize, ColorType pColorType)=0 throw (VisualException)
virtual CLData *	createCL (CLMemoryUsage pUsage, CLDevice &pDevice)=0 throw (VisualException)
virtual CLData *	createCL (const math::Vector< int > &pSize, ColorType pColorType, CLMemoryUsage pUsage, CLDevice &pDevice)=0 throw (VisualException)
virtual CLData *	createCL (GLImage *pGLImage, CLMemoryUsage pUsage, CLDevice &pDevice)=0 throw (VisualException)
virtual base::String	info () const=0
	return textual attribute data information
Protected Member Functions
virtual void	copyAttributesTo (AttributeData &pAttributeData) const =0 throw (VisualException)
	copy properties of this AttributeData to the parameter AttributeData
virtual void	copyAttributesFrom (const AttributeData &pAttributeData)=0 throw (VisualException)
	copy properties from Parameter AttributeData to this AttributeData
Protected Attributes
base::String	mAttributeName
unsigned int	mAttributeDim
unsigned int	mAttributeCount
const std::type_info *	mAttributeType
void *	mAttributes

---

Constructor & Destructor Documentation

template<typename AttributeType>

iso::visual::AttributeData::AttributeData	(	const base::String &	pAttributeName,
		int	pAttributeCount,
		int	pAttributeDim,
		AttributeType *	pValues
	)

create attribute data

Parameters:

	pAttributeName	name of attribute
	pAttributeCount	number of attributes
	pAttributeDim	attribute dimension
	pValues	values of attributes

AttributeData::AttributeData

(

)

create attribute data

AttributeData::AttributeData

(

const AttributeData &

pAttributeData

)

create attribute data

Parameters:

pAttributeData

attribute data to copy

AttributeData::AttributeData	(	const base::String &	pAttributeName,
		const AttributeData &	pAttributeData
	)

create attribute data

Parameters:

	pAttributeName	name of attribute
	pAttributeData	attribute data to copy

AttributeData::~AttributeData

(

)

[virtual]

destructor

---

Member Function Documentation

virtual const AttributeData& iso::visual::AttributeData::operator=

(

const AttributeData &

pAttributeData

)

throw (VisualException) [pure virtual]

create copy of attribute data

Parameters:

pAttributeName

attribute data

Exceptions:

VisualException

attribute type mismatch

Implemented in iso::visual::TypedAttributeData< AttributeType >.

template<typename AttributeType>

iso::visual::AttributeData::operator AttributeType *

(

)

const throw (VisualException)

return attributes

Returns:

attributes

Exceptions:

Exception

wrong attribute type

template<typename AttributeType>

iso::visual::AttributeData::operator AttributeType *

(

)

throw (VisualException)

return attributes

Returns:

attributes

Exceptions:

Exception

wrong attribute type

virtual AttributeData* iso::visual::AttributeData::copy

(

)

const [pure virtual]

create a new copy of attribute data

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual AttributeData* iso::visual::AttributeData::copy

(

const base::String &

pAttributeName

)

const [pure virtual]

create a new copy of attribute data

Parameters:

pAttributeName

attribute name

Implemented in iso::visual::TypedAttributeData< AttributeType >.

const base::String & AttributeData::attributeName

(

)

const

return attribute name

Returns:

attribute name

const std::type_info * AttributeData::attributeType

(

)

const

return attribute type

Returns:

attribute type

int AttributeData::attributeCount

(

)

const

return attribute count

Returns:

value count

int AttributeData::attributeDim

(

)

const

return attribute dimension

Returns:

attribute dimension

template<typename AttributeType>

const AttributeType * iso::visual::AttributeData::attributes

(

)

const throw (VisualException)

return attributes

Returns:

attributes

Exceptions:

Exception

wrong attribute type

template<typename AttributeType>

AttributeType * iso::visual::AttributeData::attributes

(

)

throw (VisualException)

return attributes

Returns:

attributes

Exceptions:

Exception

wrong attribute type

template<typename AttributeType>

const AttributeType * iso::visual::AttributeData::operator[]

(

unsigned int

pIndex

)

const throw (VisualException) [inline]

access array value

Parameters:

pIndex

index of value

Returns:

valze

Exceptions:

Exception

wrong attribute type, index out of range

template<typename AttributeType>

AttributeType * iso::visual::AttributeData::operator[]

(

unsigned int

pIndex

)

throw (VisualException) [inline]

access array value

Parameters:

pIndex

index of value

Returns:

value

Exceptions:

Exception

wrong attribute type, index out of range

virtual GLData* iso::visual::AttributeData::createGL	(	GLBufferType	pType,
		GLBufferUsage	pUsage
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual GLData* iso::visual::AttributeData::createGL	(	const math::Vector< int > &	pSize,
		ColorType	pColorType
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual CLData* iso::visual::AttributeData::createCL	(	CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual CLData* iso::visual::AttributeData::createCL	(	const math::Vector< int > &	pSize,
		ColorType	pColorType,
		CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual CLData* iso::visual::AttributeData::createCL	(	GLImage *	pGLImage,
		CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException) [pure virtual]

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual base::String iso::visual::AttributeData::info

(

)

const [pure virtual]

return textual attribute data information

Returns:

textual attrabute data information

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual void iso::visual::AttributeData::copyAttributesTo

(

AttributeData &

pAttributeData

)

const throw (VisualException) [protected, pure virtual]

copy properties of this AttributeData to the parameter AttributeData

Parameters:

pAttributeData

AttributeData whose properties are overwritten

Exceptions:

VisualException

attribute type mismatch

Implemented in iso::visual::TypedAttributeData< AttributeType >.

virtual void iso::visual::AttributeData::copyAttributesFrom

(

const AttributeData &

pAttributeData

)

throw (VisualException) [protected, pure virtual]

copy properties from Parameter AttributeData to this AttributeData

Parameters:

pAttributeData

AttributeData whose properties are duplicated

Exceptions:

VisualException

attribute type mismatch

Implemented in iso::visual::TypedAttributeData< AttributeType >.

---

Member Data Documentation

base::String iso::visual::AttributeData::mAttributeName [protected]

unsigned int iso::visual::AttributeData::mAttributeDim [protected]

unsigned int iso::visual::AttributeData::mAttributeCount [protected]

const std::type_info* iso::visual::AttributeData::mAttributeType [protected]

void* iso::visual::AttributeData::mAttributes [protected]

---

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

• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_attribute_data.h
• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_attribute_data.cpp

---