plumesim::PSFluent Class Reference

Extends the PSSource class to provide plume generation based on Fluent log files. More...

#include <PSSources.h>

Inheritance diagram for plumesim::PSFluent:

List of all members.

Public Member Functions
int	cleanup ()
	Function for cleaning up the class.
int	generatePoints ()
	Function for generating plume points based on a set of Fluent log files.
int	getChemicalReading (PSPoint3d *point, PSOdorData *odor_data)
	Function for reading a single chemical point based on the robot current position.
	PSFluent ()
	PSFluent constructor. This is the class constructor.
int	setup ()
	Function for setting up the class.
	~PSFluent ()
	PSFluent destructor.
Public Attributes
double	cellSize
int	currentFrame
std::string	fileName
FILE *	logFile
double	maxOdorValue
int	maxPointsPerCell
int	numOfFrames
Private Attributes
std::vector< PSFramePoint >	frame

---

Detailed Description

Extends the PSSource class to provide plume generation based on Fluent log files.

Definition at line 494 of file PSSources.h.

---

Constructor & Destructor Documentation

plumesim::PSFluent::PSFluent

(

)

PSFluent constructor. This is the class constructor.

Definition at line 45 of file PSFluent.cpp.

plumesim::PSFluent::~PSFluent

(

)

PSFluent destructor.

This is the class destructor.

Definition at line 56 of file PSFluent.cpp.

---

Member Function Documentation

int plumesim::PSFluent::cleanup

(

)

[virtual]

Function for cleaning up the class.

Parameters:

none.

Returns:

none.

Reimplemented from plumesim::PSSource.

Definition at line 80 of file PSFluent.cpp.

int plumesim::PSFluent::generatePoints

(

)

[virtual]

Function for generating plume points based on a set of Fluent log files.

Parameters:

none.

Returns:

0 - if successful

-1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 89 of file PSFluent.cpp.

int plumesim::PSFluent::getChemicalReading	(	PSPoint3d *	point,
		PSOdorData *	odor_data
	)		[virtual]

Function for reading a single chemical point based on the robot current position.

Parameters:

point	A 3D point containning the current position of the robot.
odor_data	The odor data structure where the result is written.

Returns:

0 - if successful

-1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 146 of file PSFluent.cpp.

int plumesim::PSFluent::setup

(

)

[virtual]

Function for setting up the class.

Parameters:

none.

Returns:

none.

Reimplemented from plumesim::PSSource.

Definition at line 63 of file PSFluent.cpp.

---

Member Data Documentation

double plumesim::PSFluent::cellSize

Cell size of the grid in meters.

Definition at line 558 of file PSSources.h.

int plumesim::PSFluent::currentFrame

Current frame index.

Definition at line 557 of file PSSources.h.

std::string plumesim::PSFluent::fileName

Path to the log file.

Definition at line 554 of file PSSources.h.

std::vector<PSFramePoint> plumesim::PSFluent::frame [private]

Current frame.

Definition at line 564 of file PSSources.h.

FILE* plumesim::PSFluent::logFile

Pointer to the log file.

Definition at line 553 of file PSSources.h.

double plumesim::PSFluent::maxOdorValue

Maximum odor value.

Definition at line 560 of file PSSources.h.

int plumesim::PSFluent::maxPointsPerCell

Maximum number of points to be drawn for each cell.

Definition at line 559 of file PSSources.h.

int plumesim::PSFluent::numOfFrames

Number of frames.

Definition at line 556 of file PSSources.h.

---

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

• PSSources.h
• PSFluent.cpp