iso::visual::Dataset Class Reference

#include <iso_visual_dataset.h>

Inherits iso::visual::Data.

Inherited by iso::visual::Image, and iso::visual::Mesh.

Inheritance diagram for iso::visual::Dataset:

[legend]Collaboration diagram for iso::visual::Dataset:

[legend]List of all members.

Public Member Functions
	Dataset (const base::String &pName, const PointData &pPointData)
	create dataset
	Dataset (const Dataset &pDataset)
	create dataset
	~Dataset ()
	destructor
virtual GLData *	createGL () throw (VisualException)
virtual CLData *	createCL () throw (VisualException)
virtual const Dataset &	operator= (const Dataset &pDataset) throw (VisualException)
const PointData &	pointData () const throw (VisualException)
	return point data
const AttributeData &	attributeData (const base::String &pAttributeName) const throw (VisualException)
	retrieve attribute data
template<typename AttributeType>
const AttributeType *	attributes (const base::String &pAttributeName) const throw (VisualException)
	retrieve attributes
template<typename AttributeType>
AttributeType *	attributes (const base::String &pAttributeName) throw (VisualException)
	retrieve attributes
template<typename AttributeType>
const AttributeType *	attribute (const base::String &pAttributeName, int pIndex) const throw (VisualException)
	retrieve attribute
template<typename AttributeType>
AttributeType *	attribute (const base::String &pAttributeName, int pIndex) throw (VisualException)
	retrieve attribute
template<typename AttributeType>
const AttributeType *	attribute (const base::String &pAttributeName, int pGridCoord[]) const throw (VisualException)
	retrieve attribute
template<typename AttributeType>
AttributeType *	attribute (const base::String &pAttributeName, int pGridCoord[]) throw (VisualException)
	retrieve attribute
template<typename AttributeType>
void	attribute (const base::String &pAttributeName, real pPointCoord[], AttributeType pAttribute[]) const throw (VisualException)
	retrieve attribute
void	attribute (int pGridCoord[], base::String &pAttributeName, AttributeData &pAttributeData) const
	retrieve attribute data
void	attribute (real pPointCoord[], base::String &pAttributeName, AttributeData &pAttributeData) const
	retrieve attribute data
void	addAttributeData (const base::String &pAttributeName, AttributeData &pAttributeData) throw (VisualException)
	add attribute data to dataset
void	removeAttribute (base::String &pAttributeName) throw (VisualException)
	remove attribute from dataset
void	removeAttributes ()
	remove all attributes from dataset
virtual bool	checkGL ()
bool	checkGL (const base::String &pAttributeName)
virtual bool	checkCL ()
bool	checkCL (const base::String &pAttributeName)
virtual GLData *	gl () throw (VisualException)
GLData *	gl (const base::String &pAttributeName) throw (VisualException)
virtual CLData *	cl () throw (VisualException)
CLData *	cl (const base::String &pAttributeName) throw (VisualException)
GLData *	createGL (const base::String &pAttributeName) throw (VisualException)
GLData *	createGL (const base::String &pAttributeName, GLBufferType pType, GLBufferUsage pUsage) throw (VisualException)
GLData *	createGL (const base::String &pAttributeName, ColorType pColorType) throw (VisualException)
CLData *	createCL (const base::String &pAttributeName) throw (VisualException)
CLData *	createCL (const base::String &pAttributeName, CLMemoryUsage pUsage, CLDevice &pDevice) throw (VisualException)
CLData *	createCL (const base::String &pAttributeName, ColorType pColorType, CLMemoryUsage pUsage, CLDevice &pDevice) throw (VisualException)
base::String	info () const
	return textual dataset information
Protected Member Functions
	Dataset (const base::String &pName)
	default constructor
Protected Attributes
data::IndexHash< base::String, AttributeData >	mAttributeData
	attribute name, attribute values map
PointData *	mPointData
	spatial distribution of attribute data
data::IndexHash< base::String, GLData >	mGLDataRegistry
data::IndexHash< base::String, CLData >	mCLDataRegistry
Friends
std::ostream &	operator<< (std::ostream &pOstream, const Dataset &pDataset)
	output dataset

---

Constructor & Destructor Documentation

Dataset::Dataset	(	const base::String &	pName,
		const PointData &	pPointData
	)

create dataset

Parameters:

pPointData

point data

a copy of pPointData is stored within the dataset

Dataset::Dataset

(

const Dataset &

pDataset

)

create dataset

Parameters:

pDataset

dataset to copy

Dataset::~Dataset

(

)

destructor

Dataset::Dataset

(

const base::String &

pName

)

[protected]

default constructor

---

Member Function Documentation

GLData * Dataset::createGL

(

)

throw (VisualException) [virtual]

Implements iso::visual::Data.

Reimplemented in iso::visual::Image, iso::visual::TypedImage< DataType >, iso::visual::Mesh, and iso::visual::TypedImage< float >.

CLData * Dataset::createCL

(

)

throw (VisualException) [virtual]

Implements iso::visual::Data.

Reimplemented in iso::visual::Image, iso::visual::TypedImage< DataType >, iso::visual::Mesh, and iso::visual::TypedImage< float >.

const Dataset & Dataset::operator=

(

const Dataset &

pDataset

)

throw (VisualException) [virtual]

Reimplemented in iso::visual::Image.

const PointData & Dataset::pointData

(

)

const throw (VisualException)

return point data

Returns:

point data

Exceptions:

VisualException

no point data available

const AttributeData & Dataset::attributeData

(

const base::String &

pAttributeName

)

const throw (VisualException)

retrieve attribute data

Parameters:

pAttributeName

name of attribute

Returns:

AttributeData

Exceptions:

VisualException

attribute name not found

template<typename AttributeType>

const AttributeType * iso::visual::Dataset::attributes

(

const base::String &

pAttributeName

)

const throw (VisualException)

retrieve attributes

Parameters:

pAttributeName

name of attribute

Returns:

attributes

Exceptions:

VisualException

attribute name not found or attribute type mismatch

template<typename AttributeType>

AttributeType * iso::visual::Dataset::attributes

(

const base::String &

pAttributeName

)

throw (VisualException)

retrieve attributes

Parameters:

pAttributeName

name of attribute

Returns:

attributes

Exceptions:

VisualException

attribute name not found or attribute type mismatch

template<typename AttributeType>

const AttributeType * iso::visual::Dataset::attribute	(	const base::String &	pAttributeName,
		int	pIndex
	)			const throw (VisualException)

retrieve attribute

Parameters:

	pAttributeName	name of attribute
	pIndex	index of sample point

Returns:

attribute

Exceptions:

VisualException

attribute name not found, index out of bounds or attribute type mismatch

template<typename AttributeType>

AttributeType * iso::visual::Dataset::attribute	(	const base::String &	pAttributeName,
		int	pIndex
	)			throw (VisualException)

retrieve attribute

Parameters:

	pAttributeName	name of attribute
	pIndex	index of sample point

Returns:

attribute

Exceptions:

VisualException

attribute name not found, index out of bounds or attribute type mismatch

template<typename AttributeType>

const AttributeType * iso::visual::Dataset::attribute	(	const base::String &	pAttributeName,
		int	pGridCoord[]
	)			const throw (VisualException)

retrieve attribute

Parameters:

	pAttributeName	name of attribute
	pGridCoord	grid coordinates of sample point

Returns:

attribute

Exceptions:

VisualException

attribute name not found, grid coordinates out of bounds or attribute type mismatch

template<typename AttributeType>

AttributeType * iso::visual::Dataset::attribute	(	const base::String &	pAttributeName,
		int	pGridCoord[]
	)			throw (VisualException)

retrieve attribute

Parameters:

	pAttributeName	name of attribute
	pGridCoord	grid coordinates of sample point

Returns:

attribute

Exceptions:

VisualException

attribute name not found, grid coordinates out of bounds or attribute type mismatch

template<typename AttributeType>

void iso::visual::Dataset::attribute	(	const base::String &	pAttributeName,
		real	pPointCoord[],
		AttributeType	pAttribute[]
	)			const throw (VisualException)

retrieve attribute

Parameters:

	pAttributeName	name of attribute
	pPointCoord	coordinates of sample point
	pAttribute	attribute (return value)

Exceptions:

VisualException

attribute name not found, point coordinates out of bounds or attribute type mismatch

void Dataset::attribute	(	int	pGridCoord[],
		base::String &	pAttributeName,
		AttributeData &	pAttributeData
	)			const

retrieve attribute data

Parameters:

	pGridCoord	grid coordinates of data sample point
	pAttributeName	name of attribute
	pAttributeData	attribute data (return value)

void Dataset::attribute	(	real	pPointCoord[],
		base::String &	pAttributeName,
		AttributeData &	pAttributeData
	)			const

retrieve attribute data

Parameters:

	pPointCoord	world coordinates of data sample point
	pAttributeName	name of attribute
	pAttributeData	attribute data (return value)

void Dataset::addAttributeData	(	const base::String &	pAttributeName,
		AttributeData &	pAttributeData
	)			throw (VisualException)

add attribute data to dataset

Parameters:

	pAttributeName	name of attribute
	pAttributeData	attribute data

Exceptions:

VisualException

attribute name already exists or attribute count doesn't match size of dataset

void Dataset::removeAttribute

(

base::String &

pAttributeName

)

throw (VisualException)

remove attribute from dataset

Parameters:

pAttributeName

name of attribute

Exceptions:

VisualException

attribute name does not exist

void Dataset::removeAttributes

(

)

remove all attributes from dataset

bool Dataset::checkGL

(

)

[virtual]

Reimplemented in iso::visual::Image, and iso::visual::Mesh.

bool Dataset::checkGL

(

const base::String &

pAttributeName

)

bool Dataset::checkCL

(

)

[virtual]

Reimplemented in iso::visual::Image, and iso::visual::Mesh.

bool Dataset::checkCL

(

const base::String &

pAttributeName

)

GLData * Dataset::gl

(

)

throw (VisualException) [virtual]

Reimplemented from iso::visual::Data.

GLData * Dataset::gl

(

const base::String &

pAttributeName

)

throw (VisualException)

CLData * Dataset::cl

(

)

throw (VisualException) [virtual]

Reimplemented from iso::visual::Data.

CLData * Dataset::cl

(

const base::String &

pAttributeName

)

throw (VisualException)

GLData * Dataset::createGL

(

const base::String &

pAttributeName

)

throw (VisualException)

GLData * Dataset::createGL	(	const base::String &	pAttributeName,
		GLBufferType	pType,
		GLBufferUsage	pUsage
	)			throw (VisualException)

GLData * Dataset::createGL	(	const base::String &	pAttributeName,
		ColorType	pColorType
	)			throw (VisualException)

CLData * Dataset::createCL

(

const base::String &

pAttributeName

)

throw (VisualException)

CLData * Dataset::createCL	(	const base::String &	pAttributeName,
		CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException)

CLData * Dataset::createCL	(	const base::String &	pAttributeName,
		ColorType	pColorType,
		CLMemoryUsage	pUsage,
		CLDevice &	pDevice
	)			throw (VisualException)

base::String Dataset::info

(

)

const

return textual dataset information

Returns:

textual dataset information

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOstream,
		const Dataset &	pDataset
	)			[friend]

output dataset

---

Member Data Documentation

data::IndexHash< base::String, AttributeData > iso::visual::Dataset::mAttributeData [protected]

attribute name, attribute values map

PointData* iso::visual::Dataset::mPointData [protected]

spatial distribution of attribute data

data::IndexHash< base::String, GLData > iso::visual::Dataset::mGLDataRegistry [protected]

data::IndexHash< base::String, CLData > iso::visual::Dataset::mCLDataRegistry [protected]

---

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

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

---