xsens::JanitorClassFuncP1< T, P1, R > Class Template Reference

Class function calling janitor class with a parameter. More...

#include <xsens_janitors.h>

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

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

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

Private Attributes
T &	m_control
bool	m_enabled
t_func_JanitorClassFunc	m_funcJCF
P1	m_param1

Detailed Description

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

Class function calling janitor class with a parameter.

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

Definition at line 417 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorClassFunc

template<class T , typename P1 , typename R = void>

typedef R(T::* xsens::JanitorClassFuncP1< T, P1, R >::t_func_JanitorClassFunc) (P1)

A function prototype for a janitor class.

Definition at line 420 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorClassFuncP1()

template<class T , typename P1 , typename R = void>

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

inline

Constructor.

Definition at line 432 of file xsens_janitors.h.

~JanitorClassFuncP1()

template<class T , typename P1 , typename R = void>

xsens::JanitorClassFuncP1< T, P1, R >::~JanitorClassFuncP1 ( )

inline

Destructor.

Definition at line 439 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class T , typename P1 , typename R = void>

void xsens::JanitorClassFuncP1< T, P1, R >::disable ( void  )

inline

Disables the function calling.

Definition at line 447 of file xsens_janitors.h.

enable()

template<class T , typename P1 , typename R = void>

void xsens::JanitorClassFuncP1< T, P1, R >::enable ( void  )

inline

Enable the function calling.

Definition at line 454 of file xsens_janitors.h.

operator=()

template<class T , typename P1 , typename R = void>

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

private

Member Data Documentation

m_control

template<class T , typename P1 , typename R = void>

T& xsens::JanitorClassFuncP1< T, P1, R >::m_control

private

Definition at line 424 of file xsens_janitors.h.

m_enabled

template<class T , typename P1 , typename R = void>

bool xsens::JanitorClassFuncP1< T, P1, R >::m_enabled

private

Definition at line 427 of file xsens_janitors.h.

m_funcJCF

template<class T , typename P1 , typename R = void>

t_func_JanitorClassFunc xsens::JanitorClassFuncP1< T, P1, R >::m_funcJCF

private

Definition at line 426 of file xsens_janitors.h.

m_param1

template<class T , typename P1 , typename R = void>

P1 xsens::JanitorClassFuncP1< T, P1, R >::m_param1

private

Definition at line 425 of file xsens_janitors.h.

---

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

• xsens_janitors.h