Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

RoadPlayer Class Reference
[Reconfigurable Interface Example: Roads]

Standalone class for playing road information. More...

#include <RoadPlayer.h>

Collaboration diagram for RoadPlayer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

bool open (utils::ConfigFile &params, utils::SymbolTable *globals)
 Open a file for playing.
bool advance ()
 Advance to the next set of road points.
bool getPoints (utils::Time &time, std::vector< utils::Vec3d > &points)
 Get the current set of road points tagged with a time.
bool nextPoints (utils::Time &time, std::vector< utils::Vec3d > &points, bool blocking=1)
 Get the next set of road points tagged with a time.
TimeSource::PlayerManager * getManager ()
 Provides access to the underlying canned data manager.

Detailed Description

Standalone class for playing road information.

This class lets you open a structured canned data file and get data from it

Definition at line 25 of file RoadPlayer.h.


Member Function Documentation

bool RoadPlayer::advance  ) 
 

Advance to the next set of road points.

Returns:
true for success, false for failure

Definition at line 46 of file RoadPlayer.cc.

Referenced by nextPoints().

bool RoadPlayer::getPoints utils::Time &  time,
std::vector< utils::Vec3d > &  points
 

Get the current set of road points tagged with a time.

Parameters:
[out] time Time the road points were detected
[out] points Detected 3D road points
Returns:
true for success, false for failure

Definition at line 56 of file RoadPlayer.cc.

References RoadDataStruct::num_points, RoadDataStruct::points, RoadDataPoint::x, RoadDataPoint::y, and RoadDataPoint::z.

Referenced by nextPoints().

bool RoadPlayer::nextPoints utils::Time &  time,
std::vector< utils::Vec3d > &  points,
bool  blocking = 1
 

Get the next set of road points tagged with a time.

This could have a side effect of advancing the file pointers

Parameters:
[out] time Time the road points were detected
[out] points Detected 3D road points
[in] blocking If false we will poll the manager to see if we need to advance
Returns:
true for success, false for failure

Definition at line 75 of file RoadPlayer.cc.

References advance(), and getPoints().

Referenced by PlayerRoadSource::getPoints().

bool RoadPlayer::open utils::ConfigFile &  params,
utils::SymbolTable *  globals
 

Open a file for playing.

Parameters:
[in] params Configuration file including the file name and other standard TimeSource::PlayerManager parameters
[in] globals The global symbol table
Returns:
true on success, false on failure

Definition at line 9 of file RoadPlayer.cc.

References ROAD_DATA_FMT.

Referenced by PlayerRoadSource::init().


The documentation for this class was generated from the following files:
Generated on Fri Jun 16 13:21:25 2006 for ModUtils by  doxygen 1.4.4