FlowVis.Data.FlowData Class Reference

Contains the data needed for flow visualization. Provides a method for loading the data from a file. More...

List of all members.

Public Member Functions

 FlowData ()
 Constructor creates an empty flowData object.
FlowChannel GetChannel (int index)
 Returns the channel stored at the channel index.
bool HasVelocityTransfer ()
 Checks if a transfer function for the velocity has been assigned.
bool LoadFromFile (String filename)
 Loads the data from the specified files. Both, the dat and the grid file are loaded.
void Release ()
 Deletes all channel data.

Properties

int ChannelCount [get]
 Get the number of channels stored in this flow data;.
FlowGeometry Geometry [get]
 Get the geometry object which defines the grid for this data.
TransferFunction VelocityTransfer [get, set]
 set or get the transfer function for the velocity (which has no own channel but consists of three individual channels for the flow in the xyz-directions)


Detailed Description

Contains the data needed for flow visualization. Provides a method for loading the data from a file.


Constructor & Destructor Documentation

FlowVis.Data.FlowData.FlowData (  ) 

Constructor creates an empty flowData object.


Member Function Documentation

FlowChannel FlowVis.Data.FlowData.GetChannel ( int  index  ) 

Returns the channel stored at the channel index.

Parameters:
index index of the desired channel
Returns:
channel identified by the index

bool FlowVis.Data.FlowData.HasVelocityTransfer (  ) 

Checks if a transfer function for the velocity has been assigned.

Returns:
true if a transfer function for the velocity exists

bool FlowVis.Data.FlowData.LoadFromFile ( String  filename  ) 

Loads the data from the specified files. Both, the dat and the grid file are loaded.

Parameters:
filename filename without file extension
Returns:
true if the file loading was successful

void FlowVis.Data.FlowData.Release (  ) 

Deletes all channel data.


Property Documentation

int FlowVis.Data.FlowData.ChannelCount [get]

Get the number of channels stored in this flow data;.

FlowGeometry FlowVis.Data.FlowData.Geometry [get]

Get the geometry object which defines the grid for this data.

TransferFunction FlowVis.Data.FlowData.VelocityTransfer [get, set]

set or get the transfer function for the velocity (which has no own channel but consists of three individual channels for the flow in the xyz-directions)


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 16:09:36 2008 for FlowVis by  doxygen 1.5.1-p1