OpenWalnut
1.4.0
|
Base class for all data set types. More...
#include <WDataSet.h>
Public Types | |
typedef boost::shared_ptr < WDataSet > | SPtr |
Shared pointer abbreviation to a instance of this class. | |
typedef boost::shared_ptr < const WDataSet > | ConstSPtr |
Shared pointer abbreviation to a const instance of this class. | |
Public Member Functions | |
WDataSet () | |
This constructor should be used if a dataSet does not stem from a file. | |
virtual | ~WDataSet () |
Since WDataSet is a base class and thus should be polymorphic we add virtual destructor. | |
void | setFilename (const std::string filename) |
Set the name of the file that this data set stems from. | |
std::string | getFilename () const |
Get the name of the file that this data set stems from. | |
OW_API_DEPRECATED void | setFileName (const std::string filename) |
Set the name of the file that this data set stems from. | |
OW_API_DEPRECATED std::string | getFileName () const |
Get the name of the file that this data set stems from. | |
virtual bool | isTexture () const |
Determines whether this dataset can be used as a texture. | |
virtual boost::shared_ptr < WDataSetVector > | isVectorDataSet () |
Checks if this dataset is a vector dataset. | |
virtual osg::ref_ptr < WDataTexture3D > | getTexture () const |
Returns the texture- representation of the dataset. | |
virtual const std::string | getName () const |
Gets the name of this prototype. | |
virtual const std::string | getDescription () const |
Gets the description for this prototype. | |
boost::shared_ptr< WProperties > | getProperties () const |
Return a pointer to the properties object of the dataset. | |
boost::shared_ptr< WProperties > | getInformationProperties () const |
Return a pointer to the information properties object of the dataset. | |
Static Public Member Functions | |
static boost::shared_ptr < WPrototyped > | getPrototype () |
Returns a prototype instantiated with the true type of the deriving class. | |
Protected Attributes | |
boost::shared_ptr< WProperties > | m_properties |
The property object for the dataset. | |
boost::shared_ptr< WProperties > | m_infoProperties |
The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". | |
Static Protected Attributes | |
static boost::shared_ptr < WPrototyped > | m_prototype = boost::shared_ptr< WPrototyped >() |
The prototype as singleton. | |
Private Attributes | |
std::string | m_filename |
Name of the file this data set was loaded from. |
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.
typedef boost::shared_ptr< const WDataSet > WDataSet::ConstSPtr |
Shared pointer abbreviation to a const instance of this class.
Reimplemented in WDataSetFibers, WDataSetHierarchicalClustering, WDataSetSingle, WDataSetScalar, WDataSetSphericalHarmonics, WDataSetPoints, and WDataSetVector.
Definition at line 62 of file WDataSet.h.
typedef boost::shared_ptr< WDataSet > WDataSet::SPtr |
Shared pointer abbreviation to a instance of this class.
Reimplemented in WDataSetFibers, WDataSetHierarchicalClustering, WDataSetSingle, WDataSetScalar, WDataSetSphericalHarmonics, WDataSetFiberVector, WDataSetPoints, and WDataSetVector.
Definition at line 57 of file WDataSet.h.
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 | ( | ) | [inline, virtual] |
Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.
Definition at line 74 of file WDataSet.h.
const std::string WDataSet::getDescription | ( | ) | const [virtual] |
Gets the description for this prototype.
Implements WPrototyped.
Reimplemented in WDataSetFibers, WDataSetSingle, WEEG, WDataSetSphericalHarmonics, WDataSetRawHARDI, WDataSetScalar, WDataSetPoints, WDataSetFiberVector, WDataSetSegmentation, WEEG2, WDataSetHierarchicalClustering, 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.
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.
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.
Definition at line 108 of file WDataSet.cpp.
References m_infoProperties.
const std::string WDataSet::getName | ( | ) | const [virtual] |
Gets the name of this prototype.
Implements WPrototyped.
Reimplemented in WDataSetFibers, WDataSetSingle, WEEG, WDataSetSphericalHarmonics, WDataSetRawHARDI, WDataSetScalar, WDataSetPoints, WDataSetFiberVector, WDataSetSegmentation, WEEG2, WDataSetHierarchicalClustering, 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.
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.
Reimplemented in WDataSetFibers, WDataSetScalar, WDataSetSingle, WDataSetSegmentation, WEEG, WDataSetPoints, WDataSetFiberVector, WEEG2, WDataSetSphericalHarmonics, WDataSetRawHARDI, WDataSetVector, WDataSetHierarchicalClustering, WDataSetTimeSeries, WDataSetDipoles, and WRecording.
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.
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.
Reimplemented in WDataSetFibers, WDataSetSphericalHarmonics, WDataSetSingle, WDataSetVector, WEEG, WDataSetPoints, 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.
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.
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.
filename | the string representing the name |
Definition at line 47 of file WDataSet.cpp.
References setFilename().
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 191 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 183 of file WDataSet.h.
Referenced by getInformationProperties(), WDataSetFibers::init(), WDataSet(), and WDataSetSingle::WDataSetSingle().
boost::shared_ptr< WProperties > WDataSet::m_properties [protected] |
The property object for the dataset.
Definition at line 176 of file WDataSet.h.
Referenced by getProperties(), and WDataSetFibers::init().
boost::shared_ptr< WPrototyped > WDataSet::m_prototype = boost::shared_ptr< WPrototyped >() [static, protected] |
The prototype as singleton.
Reimplemented in WDataSetFibers, WDataSetTimeSeries, WDataSetPoints, WDataSetScalar, WDataSetSegmentation, WDataSetRawHARDI, WDataSetSingle, WEEG, WDataSetSphericalHarmonics, WDataSetDipoles, WDataSetVector, WDataSetFiberVector, WEEG2, WDataSetHierarchicalClustering, WDataSetDTI, and WRecording.
Definition at line 171 of file WDataSet.h.
Referenced by getPrototype().