OpenIndy-Core  0.2.0.43
oi::Sensor Class Reference

The Sensor class. More...

#include <sensor.h>

Inheritance diagram for oi::Sensor:
oi::LaserTracker oi::TotalStation

Public Types

enum  SensorMessage { eSensorOk, eSensorWarning, eSensorError }
 

Signals

void sensorMessage (const QString &msg, const MessageTypes &msgType, const MessageDestinations &msgDest=eConsoleMessage)
 
void sensorMessage (const SensorMessage &type, const QString &msg, const MessageTypes &msgType, const MessageDestinations &msgDest=eConsoleMessage)
 

Public Member Functions

 Sensor (QObject *parent=0)
 Sensor::Sensor. More...
 
virtual ~Sensor ()
 Sensor::~Sensor. More...
 
virtual void init ()
 Sensor::init. More...
 
const SensorConfigurationgetSensorConfiguration () const
 Sensor::getSensorConfiguration. More...
 
void setSensorConfiguration (const SensorConfiguration &sConfig)
 Sensor::setSensorConfiguration. More...
 
const QPair< ReadingTypes, QPointer< Reading > > & getLastReading () const
 Sensor::getLastReading. More...
 
const QList< ReadingTypes > & getSupportedReadingTypes () const
 Sensor::getSupportedReadingTypes. More...
 
const QList< SensorFunctions > & getSupportedSensorActions () const
 Sensor::getSupportedSensorActions. More...
 
const QList< ConnectionTypes > & getSupportedConnectionTypes () const
 Sensor::getSupportedConnectionTypes. More...
 
const PluginMetaDatagetMetaData () const
 Sensor::getMetaData. More...
 
const QMap< QString, int > & getIntegerParameter () const
 Sensor::getIntegerParameter. More...
 
const QMap< QString, double > & getDoubleParameter () const
 Sensor::getDoubleParameter. More...
 
const QMultiMap< QString, QString > & getStringParameter () const
 Sensor::getStringParameter. More...
 
const QStringList & getSelfDefinedActions () const
 Sensor::getSelfDefinedActions. More...
 
const QMap< QString, double > & getDefaultAccuracy () const
 Sensor::getDefaultAccuracy. More...
 
virtual bool accept (const SensorFunctions &method, const SensorAttributes &sAttr)
 Sensor::accept Calls the appropriate internal sensor method. More...
 
virtual bool abortAction ()
 Sensor::abortAction. More...
 
virtual bool connectSensor ()
 Sensor::connectSensor. More...
 
virtual bool disconnectSensor ()
 Sensor::disconnectSensor. More...
 
virtual QList< QPointer< Reading > > measure (const MeasurementConfig &mConfig)
 Sensor::measure. More...
 
virtual QVariantMap readingStream (const ReadingTypes &streamFormat)
 Sensor::readingStream. More...
 
virtual bool getConnectionState ()
 Sensor::getConnectionState. More...
 
virtual bool getIsReadyForMeasurement ()
 Sensor::getIsReadyForMeasurement. More...
 
virtual bool getIsBusy ()
 Sensor::getIsBusy. More...
 
virtual QMap< QString, QString > getSensorStatus ()
 Sensor::getSensorStatus. More...
 
virtual bool doSelfDefinedAction (const QString &action)
 Sensor::doSelfDefinedAction. More...
 
QDomElement toOpenIndyXML (QDomDocument &xmlDoc) const
 Sensor::toOpenIndyXML. More...
 
bool fromOpenIndyXML (QDomElement &xmlElem)
 Sensor::fromOpenIndyXML. More...
 

Protected Attributes

SensorConfiguration sensorConfiguration
 
QPair< ReadingTypes, QPointer< Reading > > lastReading
 
QList< ReadingTypessupportedReadingTypes
 
QList< SensorFunctionssupportedSensorActions
 
QList< ConnectionTypessupportedConnectionTypes
 
QStringList selfDefinedActions
 
QMap< QString, double > defaultAccuracy
 
PluginMetaData metaData
 
QMap< QString, int > integerParameters
 
QMap< QString, double > doubleParameters
 
QMultiMap< QString, QString > stringParameters
 

Detailed Description

The Sensor class.

Member Enumeration Documentation

Enumerator
eSensorOk 
eSensorWarning 
eSensorError 

Constructor & Destructor Documentation

Sensor::Sensor ( QObject *  parent = 0)
explicit

Sensor::Sensor.

Parameters
parent
Sensor::~Sensor ( )
virtual

Member Function Documentation

bool Sensor::abortAction ( )
virtual
bool Sensor::accept ( const SensorFunctions method,
const SensorAttributes sAttr 
)
virtual

Sensor::accept Calls the appropriate internal sensor method.

Parameters
method
sAttr
Returns

Reimplemented in oi::LaserTracker, and oi::TotalStation.

bool Sensor::connectSensor ( )
virtual
bool Sensor::disconnectSensor ( )
virtual
bool Sensor::doSelfDefinedAction ( const QString &  action)
virtual

Sensor::doSelfDefinedAction.

Parameters
action
Returns
bool Sensor::fromOpenIndyXML ( QDomElement &  xmlElem)

Sensor::fromOpenIndyXML.

Parameters
xmlElem
Returns
bool Sensor::getConnectionState ( )
virtual
const QMap< QString, double > & Sensor::getDefaultAccuracy ( ) const
const QMap< QString, double > & Sensor::getDoubleParameter ( ) const
const QMap< QString, int > & Sensor::getIntegerParameter ( ) const
bool Sensor::getIsBusy ( )
virtual
bool Sensor::getIsReadyForMeasurement ( )
virtual
const QPair< ReadingTypes, QPointer< Reading > > & Sensor::getLastReading ( ) const
const PluginMetaData & Sensor::getMetaData ( ) const
const QStringList & Sensor::getSelfDefinedActions ( ) const
const SensorConfiguration & Sensor::getSensorConfiguration ( ) const
QMap< QString, QString > Sensor::getSensorStatus ( )
virtual
const QMultiMap< QString, QString > & Sensor::getStringParameter ( ) const
const QList< ConnectionTypes > & Sensor::getSupportedConnectionTypes ( ) const
const QList< ReadingTypes > & Sensor::getSupportedReadingTypes ( ) const
const QList< SensorFunctions > & Sensor::getSupportedSensorActions ( ) const
void Sensor::init ( )
virtual
QList< QPointer< Reading > > Sensor::measure ( const MeasurementConfig mConfig)
virtual

Sensor::measure.

Parameters
mConfig
Returns
QVariantMap Sensor::readingStream ( const ReadingTypes streamFormat)
virtual

Sensor::readingStream.

Parameters
streamFormat
Returns
void oi::Sensor::sensorMessage ( const QString &  msg,
const MessageTypes msgType,
const MessageDestinations msgDest = eConsoleMessage 
)
signal
void oi::Sensor::sensorMessage ( const SensorMessage type,
const QString &  msg,
const MessageTypes msgType,
const MessageDestinations msgDest = eConsoleMessage 
)
signal
void Sensor::setSensorConfiguration ( const SensorConfiguration sConfig)

Sensor::setSensorConfiguration.

Parameters
sConfig
QDomElement Sensor::toOpenIndyXML ( QDomDocument &  xmlDoc) const

Sensor::toOpenIndyXML.

Parameters
xmlDoc
Returns

Member Data Documentation

QMap<QString, double> oi::Sensor::defaultAccuracy
protected
QMap<QString, double> oi::Sensor::doubleParameters
protected
QMap<QString, int> oi::Sensor::integerParameters
protected
QPair<ReadingTypes, QPointer<Reading> > oi::Sensor::lastReading
protected
PluginMetaData oi::Sensor::metaData
protected
QStringList oi::Sensor::selfDefinedActions
protected
SensorConfiguration oi::Sensor::sensorConfiguration
protected
QMultiMap<QString, QString> oi::Sensor::stringParameters
protected
QList<ConnectionTypes> oi::Sensor::supportedConnectionTypes
protected
QList<ReadingTypes> oi::Sensor::supportedReadingTypes
protected
QList<SensorFunctions> oi::Sensor::supportedSensorActions
protected

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