DatasetDefinition Class Reference
[Algorithms]

Definition of a single dataset with id, name and dimensions, as read from configuration XML. More...

#include <dataset_definition.h>

List of all members.

Public Member Functions

 DatasetDefinition ()
 ~DatasetDefinition ()
void setName (std::string name)
std::string getName ()
void setInPlace (bool in_place)
bool isInPlace ()
void setId (std::string id)
std::string getId ()
void setType (dataset_type type)
dataset_type getType ()
std::string toString ()


Detailed Description

Definition of a single dataset with id, name and dimensions, as read from configuration XML.

The XML format is:

  /// <dataset name="[name]">
  ///   <type type="[volume|image]" bytes="[1|2|4]" />
  ///   +
  /// </dataset>
  /// 

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 52 of file dataset_definition.h.


Constructor & Destructor Documentation

DatasetDefinition  ) 
 

Constructor

Definition at line 19 of file dataset_definition.cpp.

~DatasetDefinition  ) 
 

Destructor

Definition at line 26 of file dataset_definition.cpp.


Member Function Documentation

std::string getId  ) 
 

Returns the ID of the dataset

Returns:
the ID of the dataset

Definition at line 53 of file dataset_definition.cpp.

std::string getName  ) 
 

Get the name of the dataset

Returns:
the name

Definition at line 39 of file dataset_definition.cpp.

dataset_type getType  ) 
 

Returns the type of the dataset

Returns:
the type of the dataset

Definition at line 90 of file dataset_definition.cpp.

bool isInPlace  ) 
 

Checks wheather the dataset allows in place

Returns:
true if in place, else false

Definition at line 67 of file dataset_definition.cpp.

void setId std::string  id  ) 
 

Sets the ID of the dataset

Parameters:
id the id

Definition at line 46 of file dataset_definition.cpp.

void setInPlace bool  in_place  ) 
 

Set wheater the algorithmus runs in place or not

Parameters:
in_place true if in place, false if not

Definition at line 60 of file dataset_definition.cpp.

void setName std::string  name  ) 
 

Set the name of the dataset

Parameters:
name the name

Definition at line 32 of file dataset_definition.cpp.

void setType dataset_type  type  ) 
 

Sets the type of the dataset

Parameters:
type the type

Definition at line 83 of file dataset_definition.cpp.

std::string toString  ) 
 

TODO: Comment

Definition at line 74 of file dataset_definition.cpp.


The documentation for this class was generated from the following files:
Generated on Sun Aug 13 18:20:00 2006 for iMEDgine by  doxygen 1.4.6