Manages sensor and sensor module objects and their settings. More...

Inheritance diagram for makVrv::DtSensorManager:

Public Types
typedef std::vector< DtSensor * >	SensorVec
	List of sensors.
typedef std::vector< const DtSensorModule * >	SensorModuleVec
	List of sensor modules.

Public Member Functions
virtual	~DtSensorManager ()
	DTOR.
virtual void	addSensor (DtSensor *sensor)=0
	Add a new sensor to the manager.
virtual void	removeSensor (DtSensor *sensor)=0
	Remove the sensor from the manager.
virtual DtSensor *	findSensor (const std::string &sensorName)=0
	Find a sensor by name.
virtual unsigned int	getSensorId (DtSensor *sensor)=0
	Gets the sensorId based on where it is in the map Returns the sensorId for this DtSensor object.
virtual void	getSensors (SensorVec &sensorVec) const =0
	Get a list of all getSensors currently in the manager.
virtual void	addSensorModule (DtSensorModule *sensorModule)=0
	Add a new sensor module to the manager.
virtual void	removeSensorModule (DtSensorModule *sensorModule)=0
	Remove the sensor module from the manager.
virtual std::string	generateName ()=0
	Generate a unique sensor name for a new sensor.
virtual DtSensorModule *	findSensorModule (const std::string &sensorModuleName)=0
	Find a sensor module by name.
virtual void	getSensorModules (SensorModuleVec &moduleVec) const =0
	Get a list of all registered sensor modules.
virtual void	setSensorsFromRecord (const makArchives::DtSensorSetRecord &rec)=0
	Set the getSensors in the manager from a record.
virtual void	getSensorsRecord (makArchives::DtSensorSetRecord &rec) const =0
	Get a record containing the getSensors in the manager.
virtual void	loadDefaults (bool loadOnlyFactorySettings=false)=0
	Load the default settings.
virtual void	saveAsDefaults ()=0
	Called to save the current settings as the default settings.
virtual void	exportSettings (const std::string &fileName)=0
	Exports the current cache settings to a file.
virtual void	importSettings (const std::string &fileName)=0
	Import the current cache settings from a file.
virtual DtBackupInterface *	backup ()=0
	Get the settings backup for the sensor settings.
virtual void	enableSensor (DtSensor *sensor, DtChannel &channel)=0
	Enable the specified sensor on the channel.
virtual void	disableSensor (DtSensor *sensor, DtChannel &channel)=0
	Disable the specified sensor on the channel.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtSensorManager &	instance (DtDe &de)
	Get the sensor manager instance rooted on the DtDe.
static void	registerInstance (DtSensorManager *mgr, DtDe &de)
	Register the sensor manager with the DtDe.
static DtSensorManager *	findInstance (DtDe &de)
	Find the sensor manager instance rooted on the DtDe.

Public Attributes
boost::signal< void(DtSensor *)>	signal_sensorAdded
	Emitted when a sensor is added to the manager.
boost::signal< void(DtSensor *)>	signal_sensorRemoved
	Emitted when a sensor is removed from the manager.
boost::signal< void(DtSensor *)>	signal_sensorAboutToBeDeleted
	Emitted before the manager deletes a sensor.
boost::signal< void(DtSensor *, const std::string &)>	signal_sensorRenamed
	Emitted when the manager renames a sensor.
boost::signal< void(DtChannel *, const std::string &)>	signal_sensorEnabled
	Emitted when the manager enables a sensor.

Detailed Description

Manages sensor and sensor module objects and their settings.

All DtSensor and DtSensorModule objects must be registered here

Member Typedef Documentation

typedef std::vector<DtSensor*> makVrv::DtSensorManager::SensorVec

List of sensors.

typedef std::vector<const DtSensorModule*> makVrv::DtSensorManager::SensorModuleVec

List of sensor modules.

Constructor & Destructor Documentation

virtual makVrv::DtSensorManager::~DtSensorManager ( )

virtual

DTOR.

Member Function Documentation

static DtSensorManager& makVrv::DtSensorManager::instance ( DtDe & de )

static

Get the sensor manager instance rooted on the DtDe.

Creates and registers a DtSensorManager if none is found in the DtDe

static void makVrv::DtSensorManager::registerInstance	(	DtSensorManager *	mgr,
		DtDe &	de
	)

static

Register the sensor manager with the DtDe.

This will override and delete any existing sensor manager rooted on the DtDe.

static DtSensorManager* makVrv::DtSensorManager::findInstance ( DtDe & de )

static

Find the sensor manager instance rooted on the DtDe.

Returns 0 if none is found

virtual void makVrv::DtSensorManager::addSensor ( DtSensor * sensor )

pure virtual

Add a new sensor to the manager.

If a sensor already exists with the same name, this will delete and overwrite it with the passed in sensor

virtual void makVrv::DtSensorManager::removeSensor ( DtSensor * sensor )

pure virtual

Remove the sensor from the manager.

Gives memory ownership of the sensor to the caller

virtual DtSensor* makVrv::DtSensorManager::findSensor ( const std::string & sensorName )

pure virtual

Find a sensor by name.

Returns null if no matching sensor was found Use a DtSensorControllerAgent to modify the sensor

virtual unsigned int makVrv::DtSensorManager::getSensorId ( DtSensor * sensor )

pure virtual

Gets the sensorId based on where it is in the map Returns the sensorId for this DtSensor object.

virtual void makVrv::DtSensorManager::getSensors ( SensorVec & sensorVec ) const

pure virtual

Get a list of all getSensors currently in the manager.

virtual void makVrv::DtSensorManager::addSensorModule ( DtSensorModule * sensorModule )

pure virtual

Add a new sensor module to the manager.

If a sensor module already exists with the same name, this will delete and overwrite it with the passed in sensor module

virtual void makVrv::DtSensorManager::removeSensorModule ( DtSensorModule * sensorModule )

pure virtual

Remove the sensor module from the manager.

Gives memory ownership of the sensor module to the caller

virtual std::string makVrv::DtSensorManager::generateName ( )

pure virtual

Generate a unique sensor name for a new sensor.

virtual DtSensorModule* makVrv::DtSensorManager::findSensorModule ( const std::string & sensorModuleName )

pure virtual

Find a sensor module by name.

Returns null if no matching sensor module was found

virtual void makVrv::DtSensorManager::getSensorModules ( SensorModuleVec & moduleVec ) const

pure virtual

Get a list of all registered sensor modules.

virtual void makVrv::DtSensorManager::setSensorsFromRecord ( const makArchives::DtSensorSetRecord & rec )

pure virtual

Set the getSensors in the manager from a record.

virtual void makVrv::DtSensorManager::getSensorsRecord ( makArchives::DtSensorSetRecord & rec ) const

pure virtual

Get a record containing the getSensors in the manager.

virtual void makVrv::DtSensorManager::loadDefaults ( bool loadOnlyFactorySettings = false )

pure virtual

Load the default settings.

virtual void makVrv::DtSensorManager::saveAsDefaults ( )

pure virtual

Called to save the current settings as the default settings.

virtual void makVrv::DtSensorManager::exportSettings ( const std::string & fileName )

pure virtual

Exports the current cache settings to a file.

virtual void makVrv::DtSensorManager::importSettings ( const std::string & fileName )

pure virtual

Import the current cache settings from a file.

virtual DtBackupInterface* makVrv::DtSensorManager::backup ( )

pure virtual

Get the settings backup for the sensor settings.

virtual void makVrv::DtSensorManager::enableSensor	(	DtSensor *	sensor,
		DtChannel &	channel
	)

pure virtual

Enable the specified sensor on the channel.

virtual void makVrv::DtSensorManager::disableSensor	(	DtSensor *	sensor,
		DtChannel &	channel
	)

pure virtual

Disable the specified sensor on the channel.

Member Data Documentation

boost::signal<void (DtSensor*)> makVrv::DtSensorManager::signal_sensorAdded

Emitted when a sensor is added to the manager.

boost::signal<void (DtSensor*)> makVrv::DtSensorManager::signal_sensorRemoved

Emitted when a sensor is removed from the manager.

boost::signal<void (DtSensor*)> makVrv::DtSensorManager::signal_sensorAboutToBeDeleted

Emitted before the manager deletes a sensor.

boost::signal<void (DtSensor*, const std::string&)> makVrv::DtSensorManager::signal_sensorRenamed

Emitted when the manager renames a sensor.

Arguments are the renamed sensor and the sensor's previous name

boost::signal<void (DtChannel*, const std::string&)> makVrv::DtSensorManager::signal_sensorEnabled

Emitted when the manager enables a sensor.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtSensorManager.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation