xsens::JanitorStdFunc0< ResultType > Class Template Reference

Function calling janitor class for std::function with 0 parameters. More...

#include <xsens_janitors.h>

Public Types
typedef std::function< ResultType(void)>	t_func_JanitorFunc
	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...
	JanitorStdFunc0 (t_func_JanitorFunc func, bool enabl=true)
	Constructor. More...
	~JanitorStdFunc0 ()
	Destructor. More...

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

Private Attributes
bool	m_enabled
t_func_JanitorFunc	m_funcJF

Detailed Description

template<typename ResultType = void>
class xsens::JanitorStdFunc0< ResultType >

Function calling janitor class for std::function with 0 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 514 of file xsens_janitors.h.

Member Typedef Documentation

t_func_JanitorFunc

template<typename ResultType = void>

typedef std::function<ResultType(void)> xsens::JanitorStdFunc0< ResultType >::t_func_JanitorFunc

A function prototype for a janitor function.

Definition at line 517 of file xsens_janitors.h.

Constructor & Destructor Documentation

JanitorStdFunc0()

template<typename ResultType = void>

xsens::JanitorStdFunc0< ResultType >::JanitorStdFunc0 ( t_func_JanitorFunc  func, bool  enabl = true  )

inline

Constructor.

Definition at line 526 of file xsens_janitors.h.

~JanitorStdFunc0()

template<typename ResultType = void>

xsens::JanitorStdFunc0< ResultType >::~JanitorStdFunc0 ( )

inline

Destructor.

Definition at line 531 of file xsens_janitors.h.

Member Function Documentation

disable()

template<typename ResultType = void>

void xsens::JanitorStdFunc0< ResultType >::disable ( void  )

inline

Disables the function calling.

Definition at line 539 of file xsens_janitors.h.

enable()

template<typename ResultType = void>

void xsens::JanitorStdFunc0< ResultType >::enable ( void  )

inline

Enables the function calling.

Definition at line 546 of file xsens_janitors.h.

operator=()

template<typename ResultType = void>

const JanitorStdFunc0& xsens::JanitorStdFunc0< ResultType >::operator= ( const JanitorStdFunc0< ResultType > &  )

private

Member Data Documentation

m_enabled

template<typename ResultType = void>

bool xsens::JanitorStdFunc0< ResultType >::m_enabled

private

Definition at line 521 of file xsens_janitors.h.

m_funcJF

template<typename ResultType = void>

t_func_JanitorFunc xsens::JanitorStdFunc0< ResultType >::m_funcJF

private

Definition at line 520 of file xsens_janitors.h.

---

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

• xsens_janitors.h