xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType > Class Template Reference

Function calling janitor class for function with 2 reference parameters. More...

#include <xsens_janitors.h>

Public Types
typedef ResultType(__cdecl *	t_func_JanitorFunc) (Param1Type, Param2Type)
	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...
	JanitorFunc2R (t_func_JanitorFunc func, Param1Type &control1, Param2Type &control2, bool enabl=true)
	Constructor. More...
	~JanitorFunc2R ()
	Destructor. More...

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

Private Attributes
Param1Type &	m_control1
Param2Type &	m_control2
bool	m_enabled
t_func_JanitorFunc	m_funcJF

Detailed Description

template<class Param1Type, class Param2Type, typename ResultType = void>
class xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >

Function calling janitor class for function with 2 reference parameters.

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 699 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorFunc

template<class Param1Type , class Param2Type , typename ResultType = void>

typedef ResultType(__cdecl* xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::t_func_JanitorFunc) (Param1Type, Param2Type)

A function prototype for a janitor function.

Definition at line 702 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorFunc2R()

template<class Param1Type , class Param2Type , typename ResultType = void>

xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::JanitorFunc2R ( t_func_JanitorFunc  func, Param1Type &  control1, Param2Type &  control2, bool  enabl = true  )

inline

Constructor.

Definition at line 713 of file xsens_janitors.h.

~JanitorFunc2R()

template<class Param1Type , class Param2Type , typename ResultType = void>

xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::~JanitorFunc2R ( )

inline

Destructor.

Definition at line 718 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class Param1Type , class Param2Type , typename ResultType = void>

void xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::disable ( void  )

inline

Disables the function calling.

Definition at line 726 of file xsens_janitors.h.

enable()

template<class Param1Type , class Param2Type , typename ResultType = void>

void xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::enable ( void  )

inline

Enables the function calling.

Definition at line 733 of file xsens_janitors.h.

operator=()

template<class Param1Type , class Param2Type , typename ResultType = void>

const JanitorFunc2R& xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::operator= ( const JanitorFunc2R< Param1Type, Param2Type, ResultType > &  )

private

Member Data Documentation

m_control1

template<class Param1Type , class Param2Type , typename ResultType = void>

Param1Type& xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::m_control1

private

Definition at line 705 of file xsens_janitors.h.

m_control2

template<class Param1Type , class Param2Type , typename ResultType = void>

Param2Type& xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::m_control2

private

Definition at line 706 of file xsens_janitors.h.

m_enabled

template<class Param1Type , class Param2Type , typename ResultType = void>

bool xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::m_enabled

private

Definition at line 708 of file xsens_janitors.h.

m_funcJF

template<class Param1Type , class Param2Type , typename ResultType = void>

t_func_JanitorFunc xsens::JanitorFunc2R< Param1Type, Param2Type, ResultType >::m_funcJF

private

Definition at line 707 of file xsens_janitors.h.

---

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

• xsens_janitors.h