xsens::JanitorRestore< T > Class Template Reference

Detailed Description

template<class T>
class xsens::JanitorRestore< 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 31 of file xsens_janitors.h.

#include <xSens_MT3/xsens_janitors.h>

Public Member Functions
	JanitorRestore (T &control, bool enabl=true)
	~JanitorRestore ()
void	disable (void)
void	enable (void)

Private Attributes
T &	m_control
T	m_value
bool	m_enabled

Constructor & Destructor Documentation

JanitorRestore()

template<class T>

xsens::JanitorRestore< T >::JanitorRestore ( T &  control, bool  enabl = true  )

inline

Definition at line 39 of file xsens_janitors.h.

~JanitorRestore()

template<class T>

xsens::JanitorRestore< T >::~JanitorRestore ( )

inline

Definition at line 43 of file xsens_janitors.h.

References xsens::JanitorRestore< T >::m_control, xsens::JanitorRestore< T >::m_enabled, and xsens::JanitorRestore< T >::m_value.

Member Function Documentation

disable()

template<class T>

void xsens::JanitorRestore< T >::disable ( void  )

inline

Definition at line 48 of file xsens_janitors.h.

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

enable()

template<class T>

void xsens::JanitorRestore< T >::enable ( void  )

inline

Definition at line 49 of file xsens_janitors.h.

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

Member Data Documentation

m_control

template<class T>

T& xsens::JanitorRestore< T >::m_control

private

Definition at line 34 of file xsens_janitors.h.

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

m_enabled

template<class T>

bool xsens::JanitorRestore< T >::m_enabled

private

Definition at line 36 of file xsens_janitors.h.

Referenced by xsens::JanitorRestore< T >::disable(), xsens::JanitorRestore< T >::enable(), and xsens::JanitorRestore< T >::~JanitorRestore().

m_value

template<class T>

T xsens::JanitorRestore< T >::m_value

private

Definition at line 35 of file xsens_janitors.h.

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