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

PlayerVehPoseSource Class Reference

Player interface definition for VehPoseSource. More...

Inheritance diagram for PlayerVehPoseSource:

Inheritance graph
[legend]
Collaboration diagram for PlayerVehPoseSource:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual bool getCurPose (utils::Time &time, VehPose &pose, bool blocking=1)
 Returns the latest vehicle pose along with the time at which it was collected. The call can be blocking, i.e., we block until the next unread vehicle pose is acquired, but it is usually polling, i.e., it returns immediately with the most recent vehicle pose

Parameters:
[out] time The time at which the road information was collected. (0 if the road is invalid)
[out] pose The vehicle pose
[in] blocking If true, then the call is blocking, if false, it is polling.
Returns:
true if "new" data has been acquired successfully, false on an invalid read or if no new road data has been acquired since the last read. Note an invalid read can be verified by checking to see if time.isZero() is true.

virtual bool getPose (utils::Time time, VehPose &pose)
 Returns the vehicle pose at the given time. The implementation will attempt to interpolate or extrapolate from known poses to get the pose at the desired time.

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.

bool init (utils::ConfigFile &params, utils::SymbolTable *globals)
 Initialization routine.

Detailed Description

Player interface definition for VehPoseSource.

Definition at line 16 of file PlayerVehPoseSource.cc.


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