FlowData Class Reference

class managing the data sets and related stuff like data loading, channels creation etc. More...

#include <FlowData.h>

Collaboration diagram for FlowData:
[legend]

List of all members.

Public Member Functions

 FlowData ()
 initializes the channel storage
 ~FlowData ()
 destoys all created channels
bool loadDataset (string filename, bool bigEndian)
 Loads a dataset, returns true if everything successful. You have to specify the byte order used in the data.
int getNumTimesteps ()
 Returns the number of timesteps.
int createChannel ()
 creates a new channel and returns it's address in the channels array (line 28)
void deleteChannel (int i)
 deletes the channel and all it's data at given adress
FlowChannelgetChannel (int i)
 returns a pointer to the instance of channel at given adress. This is the only way to access the channels storage (at line 28)
int createChannelGeometry (int dimension)
 creates a new channel containing the geometrical information of the given dimension (x = 0, y = 1). Returns address of the created channel in the channels array (line 28)
int createChannelVectorLength (int chX, int chY, int chZ=-1)
 creates a new channel containing the vector lengths for the given channels (channels given by IDs). Returns address of the created channel in the channels array (line 28)
int createChannelVectorLength (FlowChannel *chX, FlowChannel *chY, FlowChannel *chZ=NULL)
 creates a new channel containing the vector lengths for the given channels (channels given by reference). Returns address of the created channel
int getDimX ()
int getDimY ()

Private Attributes

bool loaded
 Is there any data loaded?
int timesteps
 Number of timesteps.
FlowGeometry geometry
 Stores the underlying geometry.
bool freeChannel [max_channels]
 is the channel slot free?
FlowChannelchannels [max_channels]
 stores the values of data channels for one time step. For time-dependent data, the best solution is to create a separate class handling channels in one timestep and to instanciate this class for all timesteps.


Detailed Description

class managing the data sets and related stuff like data loading, channels creation etc.

Constructor & Destructor Documentation

FlowData::FlowData (  ) 

initializes the channel storage

FlowData::~FlowData (  ) 

destoys all created channels


Member Function Documentation

int FlowData::createChannel (  ) 

creates a new channel and returns it's address in the channels array (line 28)

int FlowData::createChannelGeometry ( int  dimension  ) 

creates a new channel containing the geometrical information of the given dimension (x = 0, y = 1). Returns address of the created channel in the channels array (line 28)

int FlowData::createChannelVectorLength ( FlowChannel chX,
FlowChannel chY,
FlowChannel chZ = NULL 
)

creates a new channel containing the vector lengths for the given channels (channels given by reference). Returns address of the created channel

int FlowData::createChannelVectorLength ( int  chX,
int  chY,
int  chZ = -1 
)

creates a new channel containing the vector lengths for the given channels (channels given by IDs). Returns address of the created channel in the channels array (line 28)

void FlowData::deleteChannel ( int  i  ) 

deletes the channel and all it's data at given adress

FlowChannel * FlowData::getChannel ( int  i  ) 

returns a pointer to the instance of channel at given adress. This is the only way to access the channels storage (at line 28)

int FlowData::getDimX (  ) 

int FlowData::getDimY (  ) 

int FlowData::getNumTimesteps (  ) 

Returns the number of timesteps.

bool FlowData::loadDataset ( string  filename,
bool  bigEndian 
)

Loads a dataset, returns true if everything successful. You have to specify the byte order used in the data.


Member Data Documentation

FlowChannel* FlowData::channels[max_channels] [private]

stores the values of data channels for one time step. For time-dependent data, the best solution is to create a separate class handling channels in one timestep and to instanciate this class for all timesteps.

bool FlowData::freeChannel[max_channels] [private]

is the channel slot free?

Stores the underlying geometry.

bool FlowData::loaded [private]

Is there any data loaded?

int FlowData::timesteps [private]

Number of timesteps.


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

Generated on Mon Jan 26 22:10:05 2009 for FlowVis by  doxygen 1.5.7.1