Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members

IDVR.Volume.DataStructures.DataObject Class Reference

#include <DataObject.h>

List of all members.


Detailed Description

Class for representing a specific volume data object with all its attributes.

This class is part of the DataStructure namespace which is actually a subnamespace of the main namespace Volume. Furthermore the standard class Object is inherted to the DataObject class for better controlling of a particular quantity of DataObject instances (particullary the storing of those instances in standard hashtable is considerably easily).
An instance of this class should be only used for saving a specific volume data object which is part of the volume data set. Thus, all needed attributes of such a data object can be accumulated which in particular are:



Furthermore, all needed function for controlling those important attributes are defined in this class for a compete representation of a own volume data object of the whole data set.
See also:
VolumeData - the main datastructure class.

Histogram - the basic histogram class.

IRenderer - the abstract render model interface for controlling a specific render model.

Author:
Bernhard Pflugfelder
Version:
1.0
Date:
02-18-2005


Public Member Functions

 DataObject (void)
 This is the standard constructor.
 DataObject (String *n_ObjectDescription, unsigned short n_Importance, unsigned short n_DensityScope, IRenderer *n_Renderer)
 Constructor initialization by all needed specified parameters.
 ~DataObject (void)
 This is the standard deconstructor.
int getHistogramValues (void) __gc[]
 Returns the entire saved histogram as an one dimensional int array.
int getHistogramValue (unsigned short n_Density)
 Returns a spcific density count of the object's histogram.
__property unsigned short get_Importance (void)
 Returns the current importance value.
__property String * get_ObjectDescription (void)
 Returns the current object description.
__property Histogramget_DensityHistogram (void)
 Returns the current density histogram.
__property IRendererget_RenderModel (void)
 Returns the current render model.
__property void set_Importance (unsigned short n_Importance)
 Sets a new importance value for the current object.
__property void set_DensityHistogram (Histogram *n_DensityHistogram)
 Sets a new density histogram for the current object.
__property void set_RenderModel (IRenderer *n_RenderModel)
 Sets a new render model for the current object.

Private Attributes

unsigned short m_Importance
 Represents the current saved importance value for the volume object.
String * m_ObjectDescription
 Represents the current saved title for the volume object.
DataStructures::Histogramm_DensityHistogram
 Represents the current saved instance of Histogram for the volume object.
IRendererm_RenderModel
 Represents the current saved instance of IRenderer for the volume object.


Constructor & Destructor Documentation

DataObject::DataObject void   ) 
 

This is the standard constructor.

All member variables of this new instance will be set to zero/null.

DataObject::DataObject String *  n_ObjectDescription,
unsigned short  n_Importance,
unsigned short  n_DensityScope,
IRenderer n_Renderer
 

Constructor initialization by all needed specified parameters.

All member variables will be set to the corresponding given parameters.

Parameters:
n_ObjectDescription the new object description.
n_Importance the new importance value.
n_DensityScope the valid density scope for this instance (e.g. 4096).
n_Renderer the new render model.

DataObject::~DataObject void   ) 
 

This is the standard deconstructor.

Espacially the histogram and render model will be deleted.


Member Function Documentation

Histogram * DataObject::get_DensityHistogram void   ) 
 

Returns the current density histogram.

Returns:
The current density histogram as an instance of the Histogram class.

unsigned short DataObject::get_Importance void   ) 
 

Returns the current importance value.

Returns:
The current imporance value.

String * DataObject::get_ObjectDescription void   ) 
 

Returns the current object description.

Returns:
The current object description.

nt render model IRenderer * DataObject::get_RenderModel void   ) 
 

Returns the current render model.

Returns:
The current render model as an instance of the IRenderer class.

int DataObject::getHistogramValue unsigned short  n_Density  ) 
 

Returns a spcific density count of the object's histogram.

Parameters:
n_Density the specific density value.
Returns:
The count of the choosen density value.

int DataObject::getHistogramValues void   ) 
 

Returns the entire saved histogram as an one dimensional int array.

Use for fast access to Histogram instance values of the current volume object.

Returns:
An one dimensional int array.

void DataObject::set_DensityHistogram Histogram n_DensityHistogram  ) 
 

Sets a new density histogram for the current object.

Parameters:
n_DensityHistogram the new density histogram as an instance of the Histogram class.

void DataObject::set_Importance unsigned short  n_Importance  ) 
 

Sets a new importance value for the current object.

Parameters:
n_Importance the new importance value.

void DataObject::set_RenderModel IRenderer n_RenderModel  ) 
 

Sets a new render model for the current object.

Parameters:
n_RenderModel the new render model encapsulated in a standard IRenderer instance.


The documentation for this class was generated from the following files:
Generated on Sat Apr 9 11:51:01 2005 for RayCaster wiht Importance Driven Volume Rendering (IDVR) by  doxygen 1.4.1