Dataset Class Reference
[Datasets]

The abstract interface for arbitrary datasets. More...

#include <dataset.h>

Inherited by PixelDataset.

Inheritance diagram for Dataset:

[legend]List of all members.

Public Member Functions
	Dataset (dataset_type type, dataset_key_type dataset_key)
virtual	~Dataset ()
dataset_type	getDatasetType () const
dataset_key_type const &	getDatasetKey () const
bool	isDataSet () const
virtual metadata_pointer_type	getMetadata () const =0
void	setDirty (bool is_dirty)
bool	isDirty () const
Protected Member Functions
	Dataset (Dataset const &)
Protected Attributes
bool	is_data_set_
bool	is_dirty_

---

Detailed Description

The abstract interface for arbitrary datasets.

The datasets store all relevant data that can be associated with any given dataset. It provides access to a datasets image data, metadata, associated pictures, etc.

Author:

Tobias Gross (tobias.gross@imedgine.org)

Christian Koerner (christian.koerner@imedgine.org)

Alexander Lex (alexander.lex@imedgine.org)

Marc Streit (marc.streit@imedgine.org)

Martin Reininger (martin.reininger@imedgine.org)

Definition at line 47 of file dataset.h.

---

Constructor & Destructor Documentation

Dataset (  dataset_type  type, dataset_key_type  dataset_key )

Constructor Parameters: type  The type of dataset dataset_key  The unique key of the dataset Definition at line 19 of file dataset.cpp.

~Dataset (   )  [virtual]

Destructor Definition at line 30 of file dataset.cpp.

Dataset (  Dataset const &   )  [protected]

Copy constructor Definition at line 39 of file dataset.cpp.

---

Member Function Documentation

dataset_key_type const & getDatasetKey (   )  const

Return the unique key of this dataset. At the moment this key is only used for debugging purposes. Parameters: dataset_key  The unique dataset key Definition at line 53 of file dataset.cpp.

dataset_type getDatasetType (   )  const

Return the type of the dataset (2D pixel dataset, 3D pixel dataset, ...) Returns: The dataset type Definition at line 46 of file dataset.cpp.

virtual metadata_pointer_type getMetadata (   )  const [pure virtual]

Returns the metadata for this dataset Returns: The metadata of this dataset Implemented in PixelDataset.

bool isDataSet (   )  const

Tells whether the the dataset has been set (if it contains any data) Returns: true if the dataset has been set Definition at line 60 of file dataset.cpp. References Dataset::is_data_set_.

bool isDirty (   )  const

Tells whether the dataset was (possibly) modified (that is a new internal dataset has been set later than at construction time or the dataset was used in an in-place algorithm) Returns: true if the dataset was modified, false otherwise Definition at line 74 of file dataset.cpp. References Dataset::is_dirty_.

void setDirty (  bool  is_dirty  )

Sets the value of the dirty flag (this is done for the datasets used in in-place algorithm) Returns: true if the dataset was modified, false otherwise Definition at line 67 of file dataset.cpp. References Dataset::is_dirty_.

---

Member Data Documentation

bool is_data_set_ [protected]

Tells whether the dataset has been set Definition at line 123 of file dataset.h. Referenced by Dataset::isDataSet(), TwoByteVolumePixelDataset::setDatasetInternal(), TwoByteImagePixelDataset::setDatasetInternal(), OneByteVolumePixelDataset::setDatasetInternal(), OneByteImagePixelDataset::setDatasetInternal(), FourByteVolumePixelDataset::setDatasetInternal(), and FourByteImagePixelDataset::setDatasetInternal().

bool is_dirty_ [protected]

Tells whether the dataset was (possibly) modified (that is a new internal dataset has been set later than at construction time or the dataset was used in an in-place algorithm) Definition at line 130 of file dataset.h. Referenced by Dataset::isDirty(), TwoByteVolumePixelDataset::setDataset(), TwoByteImagePixelDataset::setDataset(), OneByteVolumePixelDataset::setDataset(), OneByteImagePixelDataset::setDataset(), FourByteVolumePixelDataset::setDataset(), FourByteImagePixelDataset::setDataset(), and Dataset::setDirty().

---

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

• imedgine/src/datasets/dataset.h
• imedgine/src/datasets/dataset.cpp

---