DUDS
Distributed Update of Data from Something
duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT > Class Template Reference

Handles sending signals of measurements taken by an instrument. More...

#include <MeasurementSignalSource.hpp>

Inheritance diagram for duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >:

Public Types

typedef GenericInstrument< SVT, SQT, TVT, TQT > Instrument
 
typedef duds::data::GenericMeasurement< SVT, SQT, TVT, TQT > Measurement
 
typedef boost::signals2::signal< void(const std::shared_ptr< Instrument > &, const std::shared_ptr< const Measurement > &) > MesurementSignal
 The type used for event listeners that are told of measurments. More...
 

Public Member Functions

boost::signals2::connection newMeasurementConnect (const typename MesurementSignal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for new measurements. More...
 
boost::signals2::connection newMeasurementConnect (const typename MesurementSignal::group_type &group, const typename MesurementSignal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for new measurements. More...
 
boost::signals2::connection newMeasurementConnectExtended (const typename MesurementSignal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for new measurements. More...
 
boost::signals2::connection newMeasurementConnectExtended (const typename MesurementSignal::group_type &group, const typename MesurementSignal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for new measurements. More...
 
void newMeasurementDisconnect (const typename MesurementSignal::group_type &group)
 Disconnect from the new measurement signal. More...
 
template<typename S >
void newMeasurementDisconnect (const S &slotFunc)
 Disconnect from the new measurement signal. More...
 
boost::signals2::connection oldMeasurementConnect (const typename MesurementSignal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for old measurements. More...
 
boost::signals2::connection oldMeasurementConnect (const typename MesurementSignal::group_type &group, const typename MesurementSignal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for old measurements. More...
 
boost::signals2::connection oldMeasurementConnectExtended (const typename MesurementSignal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for old measurements. More...
 
boost::signals2::connection oldMeasurementConnectExtended (const typename MesurementSignal::group_type &group, const typename MesurementSignal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
 Make a connection to receive signals for old measurements. More...
 
void oldMeasurementDisconnect (const typename MesurementSignal::group_type &group)
 Disconnect from the old measurement signal. More...
 
template<typename S >
void oldMeasurementDisconnect (const S &slotFunc)
 Disconnect from the old measurement signal. More...
 

Protected Member Functions

 GenericMeasurementSignalSource ()=default
 This class is intened to be used as a base class. More...
 
 GenericMeasurementSignalSource (const GenericMeasurementSignalSource &)=default
 This class is intened to be used as a base class. More...
 

Protected Attributes

MesurementSignal newMeasure
 A set of signals that are invoked when a meaurement on this Instrument is recorded that is newer than any previously recorded measurement. More...
 
MesurementSignal oldMeasure
 A set of signals that are invoked when a meaurement on this Instrument is recorded that is older than another already recorded measurement. More...
 

Detailed Description

template<class SVT, class SQT, class TVT, class TQT>
class duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >

Handles sending signals of measurements taken by an instrument.

This class is intened to be used as a base class. The functions to send signals are protected to limit access. The constructors are also protected.

Author
Jeff Jackowski

Definition at line 32 of file MeasurementSignalSource.hpp.

Member Typedef Documentation

◆ Instrument

template<class SVT , class SQT , class TVT , class TQT >
typedef GenericInstrument<SVT, SQT, TVT, TQT> duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::Instrument

Definition at line 34 of file MeasurementSignalSource.hpp.

◆ Measurement

template<class SVT , class SQT , class TVT , class TQT >
typedef duds::data::GenericMeasurement<SVT, SQT, TVT, TQT> duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::Measurement

Definition at line 35 of file MeasurementSignalSource.hpp.

◆ MesurementSignal

template<class SVT , class SQT , class TVT , class TQT >
typedef boost::signals2::signal< void (const std::shared_ptr<Instrument> &, const std::shared_ptr<const Measurement> &) > duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::MesurementSignal

The type used for event listeners that are told of measurments.

Definition at line 42 of file MeasurementSignalSource.hpp.

Constructor & Destructor Documentation

◆ GenericMeasurementSignalSource() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::GenericMeasurementSignalSource ( )
protecteddefault

This class is intened to be used as a base class.

◆ GenericMeasurementSignalSource() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::GenericMeasurementSignalSource ( const GenericMeasurementSignalSource< SVT, SQT, TVT, TQT > &  )
protecteddefault

This class is intened to be used as a base class.

Member Function Documentation

◆ newMeasurementConnect() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementConnect ( const typename MesurementSignal::slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for new measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 75 of file MeasurementSignalSource.hpp.

◆ newMeasurementConnect() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementConnect ( const typename MesurementSignal::group_type &  group,
const typename MesurementSignal::slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for new measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 87 of file MeasurementSignalSource.hpp.

◆ newMeasurementConnectExtended() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementConnectExtended ( const typename MesurementSignal::extended_slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for new measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 100 of file MeasurementSignalSource.hpp.

◆ newMeasurementConnectExtended() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementConnectExtended ( const typename MesurementSignal::group_type &  group,
const typename MesurementSignal::extended_slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for new measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 112 of file MeasurementSignalSource.hpp.

◆ newMeasurementDisconnect() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
void duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementDisconnect ( const typename MesurementSignal::group_type &  group)
inline

Disconnect from the new measurement signal.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 125 of file MeasurementSignalSource.hpp.

◆ newMeasurementDisconnect() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
template<typename S >
void duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasurementDisconnect ( const S &  slotFunc)
inline

Disconnect from the new measurement signal.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 137 of file MeasurementSignalSource.hpp.

◆ oldMeasurementConnect() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementConnect ( const typename MesurementSignal::slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for old measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 147 of file MeasurementSignalSource.hpp.

◆ oldMeasurementConnect() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementConnect ( const typename MesurementSignal::group_type &  group,
const typename MesurementSignal::slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for old measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 159 of file MeasurementSignalSource.hpp.

◆ oldMeasurementConnectExtended() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementConnectExtended ( const typename MesurementSignal::extended_slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for old measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 172 of file MeasurementSignalSource.hpp.

◆ oldMeasurementConnectExtended() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
boost::signals2::connection duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementConnectExtended ( const typename MesurementSignal::group_type &  group,
const typename MesurementSignal::extended_slot_type &  slot,
boost::signals2::connect_position  at = boost::signals2::at_back 
)
inline

Make a connection to receive signals for old measurements.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 184 of file MeasurementSignalSource.hpp.

◆ oldMeasurementDisconnect() [1/2]

template<class SVT , class SQT , class TVT , class TQT >
void duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementDisconnect ( const typename MesurementSignal::group_type &  group)
inline

Disconnect from the old measurement signal.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 197 of file MeasurementSignalSource.hpp.

◆ oldMeasurementDisconnect() [2/2]

template<class SVT , class SQT , class TVT , class TQT >
template<typename S >
void duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasurementDisconnect ( const S &  slotFunc)
inline

Disconnect from the old measurement signal.

See the Boost reference documentation for more details, or the tutorial for an overview of the whole boost::singals2 system.

Definition at line 209 of file MeasurementSignalSource.hpp.

Member Data Documentation

◆ newMeasure

template<class SVT , class SQT , class TVT , class TQT >
MesurementSignal duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::newMeasure
mutableprotected

A set of signals that are invoked when a meaurement on this Instrument is recorded that is newer than any previously recorded measurement.

Note
Declared as mutable to allow changes to this member when the object is stored in containers like std::set that keep const elements.

Definition at line 51 of file MeasurementSignalSource.hpp.

Referenced by duds::hardware::GenericMeasurementSignalGroup< SVT, SQT, TVT, TQT >::handleNewMeasure().

◆ oldMeasure

template<class SVT , class SQT , class TVT , class TQT >
MesurementSignal duds::hardware::GenericMeasurementSignalSource< SVT, SQT, TVT, TQT >::oldMeasure
mutableprotected

A set of signals that are invoked when a meaurement on this Instrument is recorded that is older than another already recorded measurement.

Note
Declared as mutable to allow changes to this member when the object is stored in containers like std::set that keep const elements.

Definition at line 59 of file MeasurementSignalSource.hpp.

Referenced by duds::hardware::GenericMeasurementSignalGroup< SVT, SQT, TVT, TQT >::handleOldMeasure().


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