xsens::JanitorFunc1R< ParamType, ResultType > Class Template Reference

Function calling janitor class for function with 1 reference parameter. More...

#include <xsens_janitors.h>

Public Types
typedef ResultType(__cdecl *	t_func_JanitorFunc) (ParamType)
	A function prototype for a janitor function. More...

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

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

Private Attributes
ParamType &	m_control
bool	m_enabled
t_func_JanitorFunc	m_funcJF

Detailed Description

template<class ParamType, typename ResultType = void>
class xsens::JanitorFunc1R< ParamType, ResultType >

Function calling janitor class for function with 1 reference parameter.

This class can be used to make sure that the given function is called on the given object when the janitor leaves scope. Take care that the object is not of a type that is destroyed before the function unrolling begins.

Definition at line 606 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorFunc

template<class ParamType , typename ResultType = void>

typedef ResultType(__cdecl* xsens::JanitorFunc1R< ParamType, ResultType >::t_func_JanitorFunc) (ParamType)

A function prototype for a janitor function.

Definition at line 609 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorFunc1R()

template<class ParamType , typename ResultType = void>

xsens::JanitorFunc1R< ParamType, ResultType >::JanitorFunc1R ( t_func_JanitorFunc  func, ParamType &  control, bool  enabl = true  )

inline

Constructor.

Definition at line 619 of file xsens_janitors.h.

~JanitorFunc1R()

template<class ParamType , typename ResultType = void>

xsens::JanitorFunc1R< ParamType, ResultType >::~JanitorFunc1R ( )

inline

Destructor.

Definition at line 624 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class ParamType , typename ResultType = void>

void xsens::JanitorFunc1R< ParamType, ResultType >::disable ( void  )

inline

Disables the function calling.

Definition at line 632 of file xsens_janitors.h.

enable()

template<class ParamType , typename ResultType = void>

void xsens::JanitorFunc1R< ParamType, ResultType >::enable ( void  )

inline

Enables the function calling.

Definition at line 639 of file xsens_janitors.h.

operator=()

template<class ParamType , typename ResultType = void>

const JanitorFunc1R& xsens::JanitorFunc1R< ParamType, ResultType >::operator= ( const JanitorFunc1R< ParamType, ResultType > &  )

private

Member Data Documentation

m_control

template<class ParamType , typename ResultType = void>

ParamType& xsens::JanitorFunc1R< ParamType, ResultType >::m_control

private

Definition at line 612 of file xsens_janitors.h.

m_enabled

template<class ParamType , typename ResultType = void>

bool xsens::JanitorFunc1R< ParamType, ResultType >::m_enabled

private

Definition at line 614 of file xsens_janitors.h.

m_funcJF

template<class ParamType , typename ResultType = void>

t_func_JanitorFunc xsens::JanitorFunc1R< ParamType, ResultType >::m_funcJF

private

Definition at line 613 of file xsens_janitors.h.

---

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

• xsens_janitors.h