Extends the PSSource class to provide plume generation based on the gaussian algorithm. More...

#include <PSSources.h>

Inheritance diagram for plumesim::PSGaussian:

Public Member Functions
int	cleanup ()
	Function for cleaning up the class.
int	generatePoints ()
	Function for generating plume points based on the gaussian algorithm.
int	getChemicalReading (PSPoint3d point, PSOdorData odor_data)
	Function for reading a single chemical point based on the robot current position.
	PSGaussian ()
	PSGaussian constructor. This is the class constructor.
int	setup ()
	Function for setting up the class.
	~PSGaussian ()
	PSGaussian destructor.
Public Attributes
PSRect	arenaRect
double	cellSize
double	diffX
double	diffY
int	maxPointsPerCell
double	radius
PSPoint3d	startPoint
Private Attributes
std::vector< PSFramePoint >	frame
int	t

Detailed Description

Extends the PSSource class to provide plume generation based on the gaussian algorithm.

Definition at line 332 of file PSSources.h.

Constructor & Destructor Documentation

plumesim::PSGaussian::PSGaussian ( )

PSGaussian constructor. This is the class constructor.

Definition at line 45 of file PSGaussian.cpp.

plumesim::PSGaussian::~PSGaussian ( )

PSGaussian destructor.

This is the class destructor.

Definition at line 67 of file PSGaussian.cpp.

Member Function Documentation

int plumesim::PSGaussian::cleanup ( ) [virtual]

Function for cleaning up the class.

Parameters:

none.

Returns:: none.

Reimplemented from plumesim::PSSource.

Definition at line 108 of file PSGaussian.cpp.

int plumesim::PSGaussian::generatePoints ( ) [virtual]

Function for generating plume points based on the gaussian algorithm.

Parameters:

none.

Returns:: 0 - if successful; -1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 117 of file PSGaussian.cpp.

int plumesim::PSGaussian::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 151 of file PSGaussian.cpp.

int plumesim::PSGaussian::setup ( ) [virtual]

Function for setting up the class.

Parameters:

none.

Returns:: none.

Reimplemented from plumesim::PSSource.

Definition at line 74 of file PSGaussian.cpp.

Member Data Documentation

PSRect plumesim::PSGaussian::arenaRect

Rectangle containing the environment.

Definition at line 392 of file PSSources.h.

double plumesim::PSGaussian::cellSize

Cell size of the grid in meters.

Definition at line 394 of file PSSources.h.

double plumesim::PSGaussian::diffX

Diffusivity constant in x.

Definition at line 397 of file PSSources.h.

double plumesim::PSGaussian::diffY

Diffusivity constant in y.

Definition at line 398 of file PSSources.h.

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

Current frame.

Definition at line 404 of file PSSources.h.

int plumesim::PSGaussian::maxPointsPerCell

Maximum number of points to be drawn for each cell.

Definition at line 395 of file PSSources.h.

double plumesim::PSGaussian::radius

Radius of the odor reading sphere.

Definition at line 393 of file PSSources.h.

PSPoint3d plumesim::PSGaussian::startPoint

Odor release point.

Definition at line 391 of file PSSources.h.

int plumesim::PSGaussian::t [private]

Current time frame.

Definition at line 402 of file PSSources.h.

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation