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

Function calling janitor class. More...

#include <xsens_janitors.h>

Public Types
typedef ResultType(__stdcall *	t_func_JanitorFuncStdCall) (ParamType)
	A function prototype for a calling janitor function. More...

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

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

Private Attributes
ParamType &	m_control
bool	m_enabled
t_func_JanitorFuncStdCall	m_funcJFSC

Detailed Description

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

Function calling janitor class.

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

Member Typedef Documentation

t_func_JanitorFuncStdCall

template<class ParamType , typename ResultType = void>

typedef ResultType(__stdcall* xsens::JanitorFuncStdCall< ParamType, ResultType >::t_func_JanitorFuncStdCall) (ParamType)

A function prototype for a calling janitor function.

Definition at line 868 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorFuncStdCall()

template<class ParamType , typename ResultType = void>

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

inline

Constructor.

Definition at line 881 of file xsens_janitors.h.

~JanitorFuncStdCall()

template<class ParamType , typename ResultType = void>

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

inline

Destructor.

Definition at line 886 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class ParamType , typename ResultType = void>

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

inline

Disables the function calling.

Definition at line 894 of file xsens_janitors.h.

enable()

template<class ParamType , typename ResultType = void>

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

inline

Enables the function calling.

Definition at line 901 of file xsens_janitors.h.

operator=()

template<class ParamType , typename ResultType = void>

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

private

Member Data Documentation

m_control

template<class ParamType , typename ResultType = void>

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

private

Definition at line 874 of file xsens_janitors.h.

m_enabled

template<class ParamType , typename ResultType = void>

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

private

Definition at line 876 of file xsens_janitors.h.

m_funcJFSC

template<class ParamType , typename ResultType = void>

t_func_JanitorFuncStdCall xsens::JanitorFuncStdCall< ParamType, ResultType >::m_funcJFSC

private

Definition at line 875 of file xsens_janitors.h.

---

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

• xsens_janitors.h