xsens::JanitorClassFunc< T, R > Class Template Reference

Class function calling janitor class. More...

#include <xsens_janitors.h>

Public Types
typedef R(T::*	t_func_JanitorClassFunc) (void)
	A function prototype for a janitor class. More...

Public Member Functions
void	disable (void)
	Disables the function calling. More...
void	enable (void)
	Enables the function calling. More...
	JanitorClassFunc (T &control, t_func_JanitorClassFunc func, bool enabl=true)
	Constructor. More...
	~JanitorClassFunc ()
	Destructor. More...

Private Member Functions
const JanitorClassFunc &	operator= (const JanitorClassFunc &)

Private Attributes
T &	m_control
bool	m_enabled
t_func_JanitorClassFunc	m_funcJCF

Detailed Description

template<class T, typename R = void>
class xsens::JanitorClassFunc< T, R >

Class function calling janitor class.

This class can be used to make sure that the given class function is called when the janitor leaves scope.

Definition at line 369 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorClassFunc

template<class T , typename R = void>

typedef R(T::* xsens::JanitorClassFunc< T, R >::t_func_JanitorClassFunc) (void)

A function prototype for a janitor class.

Definition at line 372 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorClassFunc()

template<class T , typename R = void>

xsens::JanitorClassFunc< T, R >::JanitorClassFunc ( T &  control, t_func_JanitorClassFunc< T, R >  func, bool  enabl = true  )

inline

Constructor.

Definition at line 383 of file xsens_janitors.h.

~JanitorClassFunc()

template<class T , typename R = void>

xsens::JanitorClassFunc< T, R >::~JanitorClassFunc ( )

inline

Destructor.

Definition at line 390 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class T , typename R = void>

void xsens::JanitorClassFunc< T, R >::disable ( void  )

inline

Disables the function calling.

Definition at line 398 of file xsens_janitors.h.

enable()

template<class T , typename R = void>

void xsens::JanitorClassFunc< T, R >::enable ( void  )

inline

Enables the function calling.

Definition at line 405 of file xsens_janitors.h.

operator=()

template<class T , typename R = void>

const JanitorClassFunc& xsens::JanitorClassFunc< T, R >::operator= ( const JanitorClassFunc< T, R > &  )

private

Member Data Documentation

m_control

template<class T , typename R = void>

T& xsens::JanitorClassFunc< T, R >::m_control

private

Definition at line 376 of file xsens_janitors.h.

m_enabled

template<class T , typename R = void>

bool xsens::JanitorClassFunc< T, R >::m_enabled

private

Definition at line 378 of file xsens_janitors.h.

m_funcJCF

template<class T , typename R = void>

t_func_JanitorClassFunc xsens::JanitorClassFunc< T, R >::m_funcJCF

private

Definition at line 377 of file xsens_janitors.h.

---

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

• xsens_janitors.h