Public Member Functions | Private Attributes | List of all members
xsens::JanitorDelete< T > Class Template Reference

Memory releasing janitor class. More...

#include <xsens_janitors.h>

Public Member Functions

void disable (void)
 Disables the memory releasing. More...
 
void enable (void)
 Enables the memory releasing. More...
 
 JanitorDelete ()
 Default constructor. More...
 
 JanitorDelete (T *control, bool enabl=true)
 Constructor. More...
 
T * operator-> ()
 
const T * operator-> () const
 
void setControl (T *control)
 Sets the control object. More...
 
 ~JanitorDelete ()
 Destructor. More...
 

Private Attributes

T * m_control
 
bool m_enabled
 

Detailed Description

template<class T>
class xsens::JanitorDelete< T >

Memory releasing janitor class.

This class can be used to make sure that the associated object is deleted when the janitor leaves scope.

Definition at line 189 of file xsens_janitors.h.

Constructor & Destructor Documentation

◆ JanitorDelete() [1/2]

template<class T >
xsens::JanitorDelete< T >::JanitorDelete ( )
inline

Default constructor.

Definition at line 198 of file xsens_janitors.h.

◆ JanitorDelete() [2/2]

template<class T >
xsens::JanitorDelete< T >::JanitorDelete ( T *  control,
bool  enabl = true 
)
inline

Constructor.

Definition at line 207 of file xsens_janitors.h.

◆ ~JanitorDelete()

template<class T >
xsens::JanitorDelete< T >::~JanitorDelete ( )
inline

Destructor.

Definition at line 216 of file xsens_janitors.h.

Member Function Documentation

◆ disable()

template<class T >
void xsens::JanitorDelete< T >::disable ( void  )
inline

Disables the memory releasing.

Definition at line 232 of file xsens_janitors.h.

◆ enable()

template<class T >
void xsens::JanitorDelete< T >::enable ( void  )
inline

Enables the memory releasing.

Definition at line 239 of file xsens_janitors.h.

◆ operator->() [1/2]

template<class T >
T* xsens::JanitorDelete< T >::operator-> ( )
inline
Returns
A pointer to the data. This does not detach/copy the data.

Definition at line 253 of file xsens_janitors.h.

◆ operator->() [2/2]

template<class T >
const T* xsens::JanitorDelete< T >::operator-> ( ) const
inline
Returns
A const pointer to the data. This does not detach/copy the data.

Definition at line 246 of file xsens_janitors.h.

◆ setControl()

template<class T >
void xsens::JanitorDelete< T >::setControl ( T *  control)
inline

Sets the control object.

Parameters
controlThe control object

Definition at line 225 of file xsens_janitors.h.

Member Data Documentation

◆ m_control

template<class T >
T* xsens::JanitorDelete< T >::m_control
private

Definition at line 192 of file xsens_janitors.h.

◆ m_enabled

template<class T >
bool xsens::JanitorDelete< T >::m_enabled
private

Definition at line 193 of file xsens_janitors.h.


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


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:23