iADataSet Class Reference

Abstract interface for datasets. More...

#include <iADataSet.h>

Inheritance diagram for iADataSet:

Public Member Functions
virtual	~iADataSet ()
	called when the dataset is removed/unloaded and its related resources should be released
QVariantMap const &	allMetaData () const
	return the key, value map of all metadata items associated with the dataset
bool	hasMetaData (QString const &key) const
	true if the dataset has metadata with the given key set, false otherwise
virtual QString	info () const
	should deliver information about the dataset interesting to users viewing it; implemented by derived classes
QVariant	metaData (QString const &key) const
	retrieve (optional) additional parameters for the dataset
QString	name () const
	convenience method for accessing value for NameKey in m_metaData
void	setMetaData (QString const &key, QVariant const &value)
	set an (optional) metadata key/value pair
void	setMetaData (QVariantMap const &other)
	Set bulk metadata from another key/value map.
iADataSetType	type () const
	get type of data stored in this dataset
virtual std::array< double, 3 >	unitDistance () const
	a sensible unit distance for this dataset (e.g. the spacing of a single voxel, for volume datasets)

Static Public Attributes
static const QString	FileNameKey
	metadata key for filename of the dataset
static const QString	NameKey
	metadata key for name of the dataset
static const QString	SkipSaveKey
	metadata key to mark datasets that should not be stored (e.g.

Protected Member Functions
	iADataSet (iADataSetType type)
	derived classes need to construct the dataset by giving a (proposed) filename and an (optional) name

Detailed Description

Abstract interface for datasets.

Constructor & Destructor Documentation

~iADataSet()

iADataSet::~iADataSet ( )

virtual

called when the dataset is removed/unloaded and its related resources should be released

iADataSet()

iADataSet::iADataSet ( iADataSetType type )

protected

derived classes need to construct the dataset by giving a (proposed) filename and an (optional) name

Member Function Documentation

allMetaData()

QVariantMap const & iADataSet::allMetaData

(

)

const

return the key, value map of all metadata items associated with the dataset

hasMetaData()

bool iADataSet::hasMetaData

(

QString const &

key

)

const

true if the dataset has metadata with the given key set, false otherwise

info()

QString iADataSet::info ( ) const

virtual

should deliver information about the dataset interesting to users viewing it; implemented by derived classes

Reimplemented in iADataCollection, iAGeometricObject, iAGraphData, iAImageData, iAObjectsData, and iAPolyData.

metaData()

QVariant iADataSet::metaData

(

QString const &

key

)

const

retrieve (optional) additional parameters for the dataset

name()

QString iADataSet::name

(

)

const

convenience method for accessing value for NameKey in m_metaData

setMetaData() [1/2]

void iADataSet::setMetaData	(	QString const &	key,
		QVariant const &	value )

set an (optional) metadata key/value pair

Parameters

key	the key to be added; if it already exists, its value is overwritten
value	the value for the given key

setMetaData() [2/2]

void iADataSet::setMetaData

(

QVariantMap const &

other

)

Set bulk metadata from another key/value map.

This adds/overwrites the key/value pairs given via parameter; it does NOT delete keys in the dataset's metadata which don't exist in the given parameter

Parameters

other

map of meta data; all key-value pairs in this list are added to this dataset's metadata (for already existing keys, the values are overwritten)

type()

iADataSetType iADataSet::type

(

)

const

get type of data stored in this dataset

unitDistance()

std::array< double, 3 > iADataSet::unitDistance ( ) const

virtual

a sensible unit distance for this dataset (e.g. the spacing of a single voxel, for volume datasets)

Reimplemented in iAGeometricObject, iAImageData, and iAPolyData.

Member Data Documentation

FileNameKey

const QString iADataSet::FileNameKey

static

metadata key for filename of the dataset

NameKey

const QString iADataSet::NameKey

static

metadata key for name of the dataset

SkipSaveKey

const QString iADataSet::SkipSaveKey

static

metadata key to mark datasets that should not be stored (e.g.

in projects)

---

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

• libs/base/iADataSet.h
• libs/base/iADataSet.cpp