VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtSensorModule Class Reference

Interface for a sensor implementation module. More...

Inheritance diagram for makVrv::DtSensorModule:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtSensorModule ()
 DTOR.
virtual std::string name () const =0
 Unique name of the sensor module.
virtual std::string displayName () const =0
 Display name for user interface use.
virtual void enableSensor (DtSensor &sensor, DtChannel &channel)=0
 Apply the sensor to the specified channel.
virtual void disableSensor (DtSensor &sensor, DtChannel &channel)=0
 Stop using the sensor on the specified channel.
virtual void defaultSensorConfiguration (makArchives::DtSensorRecord &rec)=0
 Fill a sensor record with defaults for this sensor module.

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.


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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)