CLocalizer based implementation of the Localizer interface. More...

Inheritance diagram for CRA::DefaultLocalizer:

Collaboration diagram for CRA::DefaultLocalizer:

Classes
struct	illegalIniFile
	Thrown when an INI file with an illegal format is provided. More...
struct	missingIniFile
	Thrown when an non-existent INI file is provided. More...
Public Types
enum	State { ready, asleep }
	Lists possible object states. More...
Public Member Functions
	DefaultLocalizer (const std::string &iniFile)
	Instantiates.
virtual	~DefaultLocalizer ()
	Shuts down the underlying CLocalizer.
virtual bool	fetch (const std::string &port, Transformation &out)
	Queries the bearing of the tool specified by some port.
void	requestState (State)
	Ensures a certain object state as far as possible.
void	loadFromIni (const std::string &iniFile)
	Reinitializes the underlying CLocalizer.

Detailed Description

CLocalizer based implementation of the Localizer interface.

Definition at line 32 of file DefaultLocalizer.h.

Member Enumeration Documentation

Lists possible object states.

Enumerator:

ready	The underlying CLocalizer is tracking.
asleep	The underlying CLocalizer is not tracking.

Definition at line 39 of file DefaultLocalizer.h.

CRA::DefaultLocalizer::DefaultLocalizer ( const std::string & iniFile )

Instantiates.

Initializes the underlying CLocalizer.

Exceptions:

illegalIniFile	when the provided INI file has an illegal format.
missingIniFile	when the provided INI file does not exist.

void CRA::DefaultLocalizer::loadFromIni ( const std::string & iniFile )

Reinitializes the underlying CLocalizer.

Exceptions:

illegalIniFile	when the provided INI file has an illegal format.
missingIniFile	when the provided INI file does not exist.

void CRA::DefaultLocalizer::requestState ( State )

Ensures a certain object state as far as possible.

Usually there is no need for requesting the object state manually.

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