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

A protected value class. More...

#include <xsens_mutex.h>

Public Member Functions

void operator= (const ProtectedValue &pv)
 Assignment operator, copies contents from the pv protected value. More...
 
 ProtectedValue (const ProtectedValue &pv)
 Constructs a protected value using a reference of another protected value. More...
 
 ProtectedValue (MutexReadWrite *mutex, bool writeLock=false)
 Constructs a protected value using a readers-writer mutex. More...
 
 ~ProtectedValue ()
 Destructor. More...
 

Public Attributes

m_value
 A type name of this class. More...
 

Private Attributes

LockReadWritem_lock
 

Detailed Description

template<typename K>
class xsens::ProtectedValue< K >

A protected value class.

Definition at line 1667 of file xsens_mutex.h.

Constructor & Destructor Documentation

◆ ProtectedValue() [1/2]

template<typename K >
xsens::ProtectedValue< K >::ProtectedValue ( MutexReadWrite mutex,
bool  writeLock = false 
)
inline

Constructs a protected value using a readers-writer mutex.

Definition at line 1675 of file xsens_mutex.h.

◆ ProtectedValue() [2/2]

template<typename K >
xsens::ProtectedValue< K >::ProtectedValue ( const ProtectedValue< K > &  pv)
inline

Constructs a protected value using a reference of another protected value.

Definition at line 1683 of file xsens_mutex.h.

◆ ~ProtectedValue()

template<typename K >
xsens::ProtectedValue< K >::~ProtectedValue ( )
inline

Destructor.

Definition at line 1692 of file xsens_mutex.h.

Member Function Documentation

◆ operator=()

template<typename K >
void xsens::ProtectedValue< K >::operator= ( const ProtectedValue< K > &  pv)
inline

Assignment operator, copies contents from the pv protected value.

Parameters
pv: The protected value to copy from

Definition at line 1701 of file xsens_mutex.h.

Member Data Documentation

◆ m_lock

template<typename K >
LockReadWrite* xsens::ProtectedValue< K >::m_lock
mutableprivate

Definition at line 1670 of file xsens_mutex.h.

◆ m_value

template<typename K >
K xsens::ProtectedValue< K >::m_value

A type name of this class.

Definition at line 1712 of file xsens_mutex.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