Flow Visualization 1.0
Public Member Functions | Static Public Member Functions

FlowData Class Reference

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

#include <FlowData.h>

List of all members.

Public Member Functions

 ~FlowData ()
 destroys 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.
FlowGeometrygetGeometry ()
 Returns the geometry class.
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 address
FlowChannelgetChannel (int i)
 returns a pointer to the instance of channel at given address. 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

Static Public Member Functions

static FlowDatainstance ()

Detailed Description

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


Constructor & Destructor Documentation

FlowData::~FlowData ( )

destroys 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 ( 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 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

void FlowData::deleteChannel ( int  i)

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

FlowChannel * FlowData::getChannel ( int  i)

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

FlowGeometry * FlowData::getGeometry ( )

Returns the geometry class.

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.


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