plumesim::PSLog Class Reference

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

#include <PSSources.h>

Inheritance diagram for plumesim::PSLog:

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 .pslog file.
int	getChemicalReading (PSPoint3d *point, PSOdorData *odor_data)
	Function for reading a single chemical point based on the robot current position.
	PSLog ()
	PSLog constructor. This is the class constructor.
int	setup ()
	Function for setting up the class.
	~PSLog ()
	PSLog destructor.
Public Attributes
double	cellSize
int	currentFrame
FILE *	logFile
std::string	logFilePath
int	maxPointsPerCell
int	numOfFrames
int	period
Private Attributes
std::vector< PSFramePoint >	frame

---

Detailed Description

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

Definition at line 414 of file PSSources.h.

---

Constructor & Destructor Documentation

plumesim::PSLog::PSLog

(

)

PSLog constructor. This is the class constructor.

Definition at line 45 of file PSLog.cpp.

plumesim::PSLog::~PSLog

(

)

PSLog destructor.

This is the class destructor.

Definition at line 53 of file PSLog.cpp.

---

Member Function Documentation

int plumesim::PSLog::cleanup

(

)

[virtual]

Function for cleaning up the class.

Parameters:

none.

Returns:

none.

Reimplemented from plumesim::PSSource.

Definition at line 83 of file PSLog.cpp.

int plumesim::PSLog::generatePoints

(

)

[virtual]

Function for generating plume points based on a .pslog file.

Parameters:

none.

Returns:

0 - if successful

-1 - otherwise

Reimplemented from plumesim::PSSource.

Definition at line 95 of file PSLog.cpp.

int plumesim::PSLog::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 139 of file PSLog.cpp.

int plumesim::PSLog::setup

(

)

[virtual]

Function for setting up the class.

Parameters:

none.

Returns:

none.

Reimplemented from plumesim::PSSource.

Definition at line 60 of file PSLog.cpp.

---

Member Data Documentation

double plumesim::PSLog::cellSize

Cell size of the grid in meters.

Definition at line 479 of file PSSources.h.

int plumesim::PSLog::currentFrame

Current index.

Definition at line 478 of file PSSources.h.

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

Current frame.

Definition at line 484 of file PSSources.h.

FILE* plumesim::PSLog::logFile

Pointer to the log file.

Definition at line 473 of file PSSources.h.

std::string plumesim::PSLog::logFilePath

Path to the log file.

Definition at line 474 of file PSSources.h.

int plumesim::PSLog::maxPointsPerCell

Maximum number of points to be drawn for each cell.

Definition at line 480 of file PSSources.h.

int plumesim::PSLog::numOfFrames

Number of frames.

Definition at line 477 of file PSSources.h.

int plumesim::PSLog::period

Original period in ms.

Definition at line 476 of file PSSources.h.

---

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

• PSSources.h
• PSLog.cpp