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

RoadSource Class Reference
[Reconfigurable Interface Example: Roads]

The RoadSource interface example. More...

#include <RoadSource.h>

Inheritance diagram for RoadSource:

Inheritance graph
List of all members.

Public Member Functions

virtual ~RoadSource ()
 Empty virtual destructor for RoadSource.
virtual bool getPoints (utils::Time &time, std::vector< utils::Vec3d > &points, bool blocking=1)=0
 Get the next set of road points.

Static Public Member Functions

static const char * intfName ()
 Get the interface name.
static RoadSourcecreate (const char *spec, utils::SymbolTable *globals=(0L))
 Create interface from string if not in symbol table already, put in symbol table afterwards under intfName()+Intf.
static RoadSourcecreate (utils::ConfigFile &params, utils::SymbolTable *globals=(0L))
 Create interface from file if not in symbol table already, put in symbol table afterwards under intfName().
static RoadSourceinterface (const char *spec, utils::SymbolTable *globals=(0L))
 Create interface from string if not in symbol table already.
static RoadSourceinterface (utils::ConfigFile &params, utils::SymbolTable *globals=(0L))
 Create interface from params if not in symbol table already.
static RoadSourcegenerate (const char *spec, utils::SymbolTable *globals=(0L))
 Create interface from string.
static RoadSourcegenerate (utils::ConfigFile &params, utils::SymbolTable *globals=(0L))
 Create interface from a parameter file.
static RoadSourceGeneratorgenerator (utils::SymbolTable *globals)
 Get the interface generator.
static RoadSourcegetIntf (utils::SymbolTable *globals)
 Get the last result of create.
static void clear (utils::SymbolTable *globals)
 Clear the interface out of the symbol table.

Detailed Description

The RoadSource interface example.

An abstract interface to 3D road information given by an STL vector of 3D points

Definition at line 26 of file RoadSource.h.

Constructor & Destructor Documentation

virtual RoadSource::~RoadSource  )  [inline, virtual]

Empty virtual destructor for RoadSource.

For C++ syntax reasons, it is a good idea to explicitly define a virtual destructor, even if empty like this one, to any abstract class like this.

Definition at line 32 of file RoadSource.h.

Member Function Documentation

virtual bool RoadSource::getPoints utils::Time &  time,
std::vector< utils::Vec3d > &  points,
bool  blocking = 1
[pure virtual]

Get the next set of road points.

Returns the latest set of road points along with the time at which they were collected. Normally, the call is blocking, i.e., we block until the next unread set of points is acquired, but it can be polling, i.e., it returns immediately with the most recent set of road points.

[out] time The time at which the road information was collected. (0 if the road is invalid)
[out] points The vector of 3D road points
[in] blocking If true, then the call is blocking, if false, it is polling.
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.

Implemented in FakeRoadSource, OutputRoadSource, PlayerRoadSource, and ShmemRoadSource.

Referenced by OutputRoadSource::getPoints().

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