FlowData Klassenreferenz

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

#include <FlowData.h>

Aufstellung aller Elemente

Öffentliche Methoden
	FlowData ()
	initializes the channel storage
	~FlowData ()
	destoys all created channels
bool	loadDataset (const char *file, 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	getNumChannels ()
string	getFileName ()
void	getDimension (int &x, int &y, int &z)
bool	isLoaded ()
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
FlowChannel *	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	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

---

Ausführliche Beschreibung

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

---

Beschreibung der Konstruktoren und Destruktoren

FlowData::FlowData

(

)

initializes the channel storage

FlowData::~FlowData

(

)

destoys all created channels

---

Dokumentation der Elementfunktionen

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)

void FlowData::getDimension	(	int &	x,
		int &	y,
		int &	z
	)			[inline]

string FlowData::getFileName

(

)

[inline]

int FlowData::getNumChannels

(

)

[inline]

int FlowData::getNumTimesteps

(

)

Returns the number of timesteps.

bool FlowData::isLoaded

(

)

[inline]

bool FlowData::loadDataset	(	const char *	file,
		bool	bigEndian
	)

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

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• C:/Users/Apocalyptica/Documents/Uni/Visualisierung LU/FlowVis/FlowVis/Framework/Include/FlowData.h