Public Member Functions | Public Attributes | Private Member Functions
plumesim::PSMeadering Class Reference

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

#include <PSSources.h>

Inheritance diagram for plumesim::PSMeadering:
Inheritance graph
[legend]

List of all members.

Public Member Functions

int cleanup ()
 Function for cleaning up the class.
int generatePoints ()
 Function for generating plume points based on the meandering algorithm.
int getChemicalReading (PSPoint3d *point, PSOdorData *odor_data)
 Function for reading a single chemical point based on the robot current position.
 PSMeadering ()
 PSMeadering constructor. This is the class constructor.
int setup ()
 Function for setting up the class.
 ~PSMeadering ()
 PSMeadering destructor.

Public Attributes

PSRect arenaRect
double dispersionCoeficient
int maxPoints
int numOfPlumePoints
double radius
double releaseRate
PSPoint3d startPoint

Private Member Functions

void linearInterpolation (PSPoint3d *points, int numOfPoints)
 Linear interpolation.

Detailed Description

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

Definition at line 243 of file PSSources.h.


Constructor & Destructor Documentation

PSMeadering constructor. This is the class constructor.

Definition at line 45 of file PSMeadering.cpp.

PSMeadering destructor.

This is the class destructor.

Definition at line 66 of file PSMeadering.cpp.


Member Function Documentation

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

Function for cleaning up the class.

Parameters:
none.
Returns:
none.

Reimplemented from plumesim::PSSource.

Definition at line 82 of file PSMeadering.cpp.

Function for generating plume points based on the meandering algorithm.

Parameters:
none.
Returns:
0 - if successful
-1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 90 of file PSMeadering.cpp.

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

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

Parameters:
pointA 3D point containning the current position of the robot.
odor_dataThe odor data structure where the result is written.
Returns:
0 - if successful
-1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 146 of file PSMeadering.cpp.

void plumesim::PSMeadering::linearInterpolation ( PSPoint3d points,
int  numOfPoints 
) [private]

Linear interpolation.

Parameters:
pointsPointer to array of points to interpolate.
numOfPointsNumber of points in the array.
newPointsPointer to linked list of points to write the result to.
Returns:
none.

Definition at line 161 of file PSMeadering.cpp.

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

Function for setting up the class.

Parameters:
none.
Returns:
none.

Reimplemented from plumesim::PSSource.

Definition at line 73 of file PSMeadering.cpp.


Member Data Documentation

Rectangle containing the environment.

Definition at line 303 of file PSSources.h.

Dispersion coeficient.

Definition at line 305 of file PSSources.h.

Maximum number of points to be drawn for each point.

Definition at line 307 of file PSSources.h.

Total number of plume points.

Definition at line 308 of file PSSources.h.

Radius of the odor reading sphere.

Definition at line 306 of file PSSources.h.

Release rate.

Definition at line 304 of file PSSources.h.

Odor release point.

Definition at line 302 of file PSSources.h.


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


plumesim
Author(s): Gonçalo Cabrita and Pedro Sousa
autogenerated on Mon Jan 6 2014 11:27:16