Base class for all data set types. More...

#include <WDataSet.h>

Inheritance diagram for WDataSet:

Public Member Functions
	WDataSet ()
	This constructor should be used if a dataSet does not stem from a file. More...

virtual	~WDataSet ()
	Since WDataSet is a base class and thus should be polymorphic we add virtual destructor. More...

void	setFilename (const std::string filename)
	Set the name of the file that this data set stems from. More...

std::string	getFilename () const
	Get the name of the file that this data set stems from. More...

OW_API_DEPRECATED void	setFileName (const std::string filename)
	Set the name of the file that this data set stems from. More...

OW_API_DEPRECATED std::string	getFileName () const
	Get the name of the file that this data set stems from. More...

virtual bool	isTexture () const
	Determines whether this dataset can be used as a texture. More...

virtual boost::shared_ptr < WDataSetVector >	isVectorDataSet ()
	Checks if this dataset is a vector dataset. More...

virtual osg::ref_ptr < WDataTexture3D >	getTexture () const
	Returns the texture- representation of the dataset. More...

virtual const std::string	getName () const
	Gets the name of this prototype. More...

virtual const std::string	getDescription () const
	Gets the description for this prototype. More...

boost::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the dataset. More...

boost::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the dataset. More...

Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor. More...

virtual	~WTransferable ()
	Destructor. More...

Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor. More...

virtual	~WPrototyped ()
	Destructor. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Static Public Member Functions
static boost::shared_ptr < WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Protected Attributes
boost::shared_ptr< WProperties >	m_properties
	The property object for the dataset. More...

boost::shared_ptr< WProperties >	m_infoProperties
	The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...

Static Protected Attributes
static boost::shared_ptr < WPrototyped >	m_prototype = boost::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Private Attributes
std::string	m_filename
	Name of the file this data set was loaded from. More...

Detailed Description

Base class for all data set types.

This class has a number of subclasses specifying the different types of data sets. Two of the dataset types represent single and time-dependent datasets (compound of several time steps) respectively.

Definition at line 51 of file WDataSet.h.

Constructor & Destructor Documentation

WDataSet::WDataSet ( )

This constructor should be used if a dataSet does not stem from a file.

It presets the correpsonding filename as empty string.

Definition at line 38 of file WDataSet.cpp.

References m_infoProperties.

Referenced by getPrototype().

virtual WDataSet::~WDataSet ( )

inlinevirtual

Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.

Definition at line 64 of file WDataSet.h.

Member Function Documentation

const std::string WDataSet::getDescription ( ) const

virtual

Gets the description for this prototype.

Returns: the description

Implements WPrototyped.

Reimplemented in WDataSetFibers, WDataSetSingle, WEEG, WDataSetRawHARDI, WDataSetSphericalHarmonics, WDataSetFiberVector, WDataSetSegmentation, WEEG2, WDataSetTimeSeries, and WRecording.

Definition at line 83 of file WDataSet.cpp.

std::string WDataSet::getFilename ( ) const

Get the name of the file that this data set stems from.

Returns: the filename.

Definition at line 63 of file WDataSet.cpp.

References m_filename.

Referenced by getFileName().

std::string WDataSet::getFileName ( ) const

Get the name of the file that this data set stems from.

Deprecated:: use getFilename instead

Returns: the filename.

Definition at line 52 of file WDataSet.cpp.

References getFilename().

boost::shared_ptr< WProperties > WDataSet::getInformationProperties ( ) const

Return a pointer to the information properties object of the dataset.

The dataset intends these properties to not be modified.

Returns: the properties.

Definition at line 108 of file WDataSet.cpp.

References m_infoProperties.

const std::string WDataSet::getName ( ) const

virtual

Gets the name of this prototype.

Returns: the name.

Implements WPrototyped.

Reimplemented in WDataSetFibers, WDataSetSingle, WEEG, WDataSetRawHARDI, WDataSetSphericalHarmonics, WDataSetFiberVector, WDataSetSegmentation, WEEG2, WDataSetTimeSeries, and WRecording.

Definition at line 78 of file WDataSet.cpp.

boost::shared_ptr< WProperties > WDataSet::getProperties ( ) const

Return a pointer to the properties object of the dataset.

Add all the modifiable settings here. This allows the user to modify several properties of a dataset.

Returns: the properties.

Definition at line 103 of file WDataSet.cpp.

References m_properties.

boost::shared_ptr< WPrototyped > WDataSet::getPrototype ( )

static

Returns a prototype instantiated with the true type of the deriving class.

Returns: the prototype.

Definition at line 88 of file WDataSet.cpp.

References m_prototype, and WDataSet().

osg::ref_ptr< WDataTexture3D > WDataSet::getTexture ( ) const

virtual

Returns the texture- representation of the dataset.

May throw an exception if no texture is available.

Returns: The texture.

Deprecated:

Reimplemented in WDataSetSingle.

Definition at line 73 of file WDataSet.cpp.

bool WDataSet::isTexture ( ) const

virtual

Determines whether this dataset can be used as a texture.

Returns: true if usable as texture.

Reimplemented in WDataSetFibers, WDataSetSingle, WDataSetVector, WDataSetSphericalHarmonics, WEEG, and WDataSetFiberVector.

Definition at line 68 of file WDataSet.cpp.

boost::shared_ptr< WDataSetVector > WDataSet::isVectorDataSet ( )

virtual

Checks if this dataset is a vector dataset.

Returns: Returns a nonempty shared_ptr to it if it is a vector dataset, otherwise the pointer is empty!

Reimplemented in WDataSetVector.

Definition at line 98 of file WDataSet.cpp.

void WDataSet::setFilename ( const std::string filename)

Set the name of the file that this data set stems from.

Parameters

filename the string representing the name

Definition at line 57 of file WDataSet.cpp.

References m_filename.

Referenced by setFileName(), WDataSetFiberVector::WDataSetFiberVector(), and WEEG2::WEEG2().

void WDataSet::setFileName ( const std::string filename)

Set the name of the file that this data set stems from.

Parameters

filename the string representing the name

Deprecated:: use setFilename instead

Definition at line 47 of file WDataSet.cpp.

References setFilename().

Member Data Documentation

std::string WDataSet::m_filename

private

Name of the file this data set was loaded from.

This information may allow hollowing data sets later. DataSets that were not loaded from a file should have the empty string stored here.

Definition at line 181 of file WDataSet.h.

Referenced by getFilename(), and setFilename().

boost::shared_ptr< WProperties > WDataSet::m_infoProperties

protected

The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

It is useful to define some property to only be of informational nature. The GUI does not modify them. As it is a WProperties instance, you can use it the same way as m_properties.

Definition at line 173 of file WDataSet.h.

Referenced by getInformationProperties(), WDataSet(), and WDataSetSingle::WDataSetSingle().

boost::shared_ptr< WProperties > WDataSet::m_properties

protected

The property object for the dataset.

Definition at line 166 of file WDataSet.h.

Referenced by getProperties(), and WDataSetFibers::init().

boost::shared_ptr< WPrototyped > WDataSet::m_prototype = boost::shared_ptr< WPrototyped >()

staticprotected

The prototype as singleton.

Definition at line 161 of file WDataSet.h.

Referenced by getPrototype().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation