Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Private Attributes
xsens::JanitorSet< T > Class Template Reference

Detailed Description

template<class T>
class xsens::JanitorSet< T >

Value restoring janitor class.

This class can be used to make sure that the value that is in the variable at the time the janitor is created will be in it again when the janitor leaves scope.

Definition at line 283 of file xsens_janitors.h.

#include <xSens_MT3/xsens_janitors.h>

Public Member Functions

 JanitorSet (T &control, const T &val, bool enabl=true)
 
 ~JanitorSet ()
 
void disable (void)
 
void enable (void)
 

Private Attributes

T & m_control
 
m_value
 
bool m_enabled
 

Constructor & Destructor Documentation

◆ JanitorSet()

template<class T>
xsens::JanitorSet< T >::JanitorSet ( T &  control,
const T &  val,
bool  enabl = true 
)
inline

Definition at line 291 of file xsens_janitors.h.

◆ ~JanitorSet()

template<class T>
xsens::JanitorSet< T >::~JanitorSet ( )
inline

Member Function Documentation

◆ disable()

template<class T>
void xsens::JanitorSet< T >::disable ( void  )
inline

Definition at line 300 of file xsens_janitors.h.

References xsens::JanitorSet< T >::m_enabled.

◆ enable()

template<class T>
void xsens::JanitorSet< T >::enable ( void  )
inline

Definition at line 301 of file xsens_janitors.h.

References xsens::JanitorSet< T >::m_enabled.

Member Data Documentation

◆ m_control

template<class T>
T& xsens::JanitorSet< T >::m_control
private

Definition at line 286 of file xsens_janitors.h.

Referenced by xsens::JanitorSet< T >::~JanitorSet().

◆ m_enabled

template<class T>
bool xsens::JanitorSet< T >::m_enabled
private

◆ m_value

template<class T>
T xsens::JanitorSet< T >::m_value
private

Definition at line 287 of file xsens_janitors.h.

Referenced by xsens::JanitorSet< T >::~JanitorSet().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019