edm::ConstRespectingPtr< T > Class Template Reference

#include <ConstRespectingPtr.h>

Public Member Functions
	ConstRespectingPtr ()
	ConstRespectingPtr (T *)
	ConstRespectingPtr (ConstRespectingPtr< T > const &)=delete
T const *	get () const
T *	get ()
bool	isSet () const
T const &	operator* () const
T &	operator* ()
T const *	operator-> () const
T *	operator-> ()
ConstRespectingPtr &	operator= (ConstRespectingPtr< T > const &)=delete
T *	release ()
void	reset ()
void	set (std::unique_ptr< T > iNewValue)
	~ConstRespectingPtr ()

Private Attributes
edm::propagate_const< T * >	m_data

Detailed Description

template<typename T>
class edm::ConstRespectingPtr< T >

Description: When this is a member of a class, const functions of the class can only call const functions of the object it points at. This aids in using the compiler to help maintain thread safety of const functions.

Usage: WARNING: member data which uses this class must be made transient in the classes_def.xml file if it is a member of a persistent class!

Definition at line 27 of file ConstRespectingPtr.h.

Constructor & Destructor Documentation

ConstRespectingPtr() [1/3]

template<typename T >

edm::ConstRespectingPtr< T >::ConstRespectingPtr

(

)

Definition at line 55 of file ConstRespectingPtr.h.

: m_data(nullptr) {}

ConstRespectingPtr() [2/3]

template<typename T>

edm::ConstRespectingPtr< T >::ConstRespectingPtr ( T *  v )

explicit

Definition at line 58 of file ConstRespectingPtr.h.

: m_data(v) {}

ConstRespectingPtr() [3/3]

template<typename T>

edm::ConstRespectingPtr< T >::ConstRespectingPtr ( ConstRespectingPtr< T > const &  )

delete

~ConstRespectingPtr()

template<typename T >

edm::ConstRespectingPtr< T >::~ConstRespectingPtr

(

)

Definition at line 61 of file ConstRespectingPtr.h.

                                             {
    delete m_data.get();
  }

Member Function Documentation

get() [1/2]

template<typename T>

T const* edm::ConstRespectingPtr< T >::get ( ) const

inline

Definition at line 37 of file ConstRespectingPtr.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), DTReadOutMapping::insertReadOutGeometryLink(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), rrapi.RRApi::workspaces(), and edm::ConstRespectingPtr< DTBufferTreeUniquePtr >::~ConstRespectingPtr().

{ return m_data; }

get() [2/2]

template<typename T>

T* edm::ConstRespectingPtr< T >::get ( )

inline

Definition at line 41 of file ConstRespectingPtr.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

{ return m_data; }

isSet()

template<typename T >

bool edm::ConstRespectingPtr< T >::isSet

(

)

const

Definition at line 66 of file ConstRespectingPtr.h.

                                          {
    return nullptr != m_data;
  }

operator*() [1/2]

template<typename T>

T const& edm::ConstRespectingPtr< T >::operator* ( void  ) const

inline

Definition at line 36 of file ConstRespectingPtr.h.

{ return *m_data; }

operator*() [2/2]

template<typename T>

T& edm::ConstRespectingPtr< T >::operator* ( void  )

inline

Definition at line 40 of file ConstRespectingPtr.h.

{ return *m_data; }

operator->() [1/2]

template<typename T>

T const* edm::ConstRespectingPtr< T >::operator-> ( ) const

inline

Definition at line 35 of file ConstRespectingPtr.h.

{ return m_data; }

operator->() [2/2]

template<typename T>

T* edm::ConstRespectingPtr< T >::operator-> ( )

inline

Definition at line 39 of file ConstRespectingPtr.h.

{ return m_data; }

operator=()

template<typename T>

ConstRespectingPtr& edm::ConstRespectingPtr< T >::operator= ( ConstRespectingPtr< T > const &  )

delete

release()

template<typename T >

T * edm::ConstRespectingPtr< T >::release

(

)

Definition at line 77 of file ConstRespectingPtr.h.

Referenced by edm::ConstRespectingPtr< DTBufferTreeUniquePtr >::set().

                                    {
    T* tmp = m_data;
    m_data = nullptr;
    return tmp;
  }

reset()

template<typename T >

void edm::ConstRespectingPtr< T >::reset

(

void

)

Definition at line 84 of file ConstRespectingPtr.h.

                                    {
    delete m_data;
    m_data = nullptr;
  }

set()

template<typename T>

void edm::ConstRespectingPtr< T >::set

(

std::unique_ptr< T >

iNewValue

)

Definition at line 71 of file ConstRespectingPtr.h.

                                                            {
    delete m_data;
    m_data = iNewValue.release();
  }

Member Data Documentation

m_data

template<typename T>

edm::propagate_const<T*> edm::ConstRespectingPtr< T >::m_data

private

Definition at line 51 of file ConstRespectingPtr.h.

Referenced by edm::ConstRespectingPtr< DTBufferTreeUniquePtr >::get(), edm::ConstRespectingPtr< DTBufferTreeUniquePtr >::operator*(), and edm::ConstRespectingPtr< DTBufferTreeUniquePtr >::operator->().