makVrv::DtSensorModule Class Reference

Interface for a sensor implementation module. More...

Inheritance diagram for makVrv::DtSensorModule:

Public Member Functions
virtual	~DtSensorModule ()
	DTOR. More...
virtual std::string	name () const =0
	Unique name of the sensor module. More...
virtual std::string	displayName () const =0
	Display name for user interface use. More...
virtual void	enableSensor (DtSensor &sensor, DtChannel &channel)=0
	Apply the sensor to the specified channel. More...
virtual void	disableSensor (DtSensor &sensor, DtChannel &channel)=0
	Stop using the sensor on the specified channel. More...
virtual void	defaultSensorConfiguration (makArchives::DtSensorRecord &rec)=0
	Fill a sensor record with defaults for this sensor module. More...
virtual bool	pendingObjectInitialization () const
	used by the SensorFX module to provide information about if the objects are initialized yet. More...

Detailed Description

Interface for a sensor implementation module.

A sensor module is responsible for rendering the sensor views configured in DtSensor objects onto channels. All DtSensorModule objects must be registered with the DtSensorManager, and should have a DtSensorConfigurationWidget for GUI-based configuration.

Constructor & Destructor Documentation

virtual makVrv::DtSensorModule::~DtSensorModule ( )

virtual

DTOR.

Member Function Documentation

virtual std::string makVrv::DtSensorModule::name ( ) const

pure virtual

Unique name of the sensor module.

Implemented in makVrv::DtSenSimSensorModule.

virtual std::string makVrv::DtSensorModule::displayName ( ) const

pure virtual

Display name for user interface use.

Implemented in makVrv::DtSenSimSensorModule.

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

pure virtual

Apply the sensor to the specified channel.

Implemented in makVrv::DtSenSimSensorModule.

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

pure virtual

Stop using the sensor on the specified channel.

Implemented in makVrv::DtSenSimSensorModule.

virtual void makVrv::DtSensorModule::defaultSensorConfiguration ( makArchives::DtSensorRecord &  rec )

pure virtual

Fill a sensor record with defaults for this sensor module.

Implemented in makVrv::DtSenSimSensorModule.

virtual bool makVrv::DtSensorModule::pendingObjectInitialization ( ) const

virtual

used by the SensorFX module to provide information about if the objects are initialized yet.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtSensorModule.h