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

VehPosePlayer Class Reference
[Reconfigurable Interface Example: VehPose]

Standalone class for playing road information. More...

#include <VehPosePlayer.h>

Collaboration diagram for VehPosePlayer:

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 vehicle pose.
bool getCurPose (utils::Time &time, VehPose &pose)
 Get the current vehicle pose tagged with a time.
bool nextPose (utils::Time &time, VehPose &pose, bool blocking=1)
 Get the next vehicle pose tagged with a time.
bool getPose (utils::Time time, VehPose &pose)
 Read the pose at a given time, interpolating and extrapolating if necessary.
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 26 of file VehPosePlayer.h.


Member Function Documentation

bool VehPosePlayer::advance  ) 
 

Advance to the next vehicle pose.

Returns:
true for success, false for failure

Definition at line 50 of file VehPosePlayer.cc.

Referenced by nextPose().

bool VehPosePlayer::getCurPose utils::Time &  time,
VehPose pose
 

Get the current vehicle pose tagged with a time.

Parameters:
[out] time Time the vehicle pose was generated
[out] pose The vehicle pose
Returns:
true for success, false for failure

Definition at line 67 of file VehPosePlayer.cc.

Referenced by nextPose().

bool VehPosePlayer::getPose utils::Time  time,
VehPose pose
 

Read the pose at a given time, interpolating and extrapolating if necessary.

Parameters:
[in] time The time for which to get the vehicle pose.
[out] pose The resulting vehicle pose
Returns:
true if the routine was able to obtain a vehicle pose at the desired time, false if not.

Definition at line 86 of file VehPosePlayer.cc.

References VehPoseSource::interpolate().

Referenced by PlayerVehPoseSource::getPose().

bool VehPosePlayer::nextPose utils::Time &  time,
VehPose pose,
bool  blocking = 1
 

Get the next vehicle pose tagged with a time.

This could have a side effect of advancing the file pointers

Parameters:
[out] time Time the vehicle pose was generated
[out] pose The vehicle pose
[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 77 of file VehPosePlayer.cc.

References advance(), and getCurPose().

Referenced by PlayerVehPoseSource::getCurPose().

bool VehPosePlayer::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 10 of file VehPosePlayer.cc.

Referenced by PlayerVehPoseSource::init().


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