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

Function calling janitor class for function with 1 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...
	JanitorFunc1 (t_func_JanitorFunc func, ParamType control, bool enabl=true)
	Constructor. More...
	~JanitorFunc1 ()
	Destructor. More...

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

Private Attributes
ParamType	m_control
bool	m_enabled
t_func_JanitorFunc	m_funcJF

Detailed Description

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

Function calling janitor class for function with 1 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 560 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorFunc

template<class ParamType , typename ResultType = void>

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

A function prototype for a janitor function.

Definition at line 563 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorFunc1()

template<class ParamType , typename ResultType = void>

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

inline

Constructor.

Definition at line 573 of file xsens_janitors.h.

~JanitorFunc1()

template<class ParamType , typename ResultType = void>

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

inline

Destructor.

Definition at line 578 of file xsens_janitors.h.

Member Function Documentation

disable()

template<class ParamType , typename ResultType = void>

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

inline

Disables the function calling.

Definition at line 586 of file xsens_janitors.h.

enable()

template<class ParamType , typename ResultType = void>

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

inline

Enables the function calling.

Definition at line 593 of file xsens_janitors.h.

operator=()

template<class ParamType , typename ResultType = void>

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

private

Member Data Documentation

m_control

template<class ParamType , typename ResultType = void>

ParamType xsens::JanitorFunc1< ParamType, ResultType >::m_control

private

Definition at line 566 of file xsens_janitors.h.

m_enabled

template<class ParamType , typename ResultType = void>

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

private

Definition at line 568 of file xsens_janitors.h.

m_funcJF

template<class ParamType , typename ResultType = void>

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

private

Definition at line 567 of file xsens_janitors.h.

---

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

• xsens_janitors.h