edm::ConstRespectingPtr< T > Class Template Reference

#include <ConstRespectingPtr.h>

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

Private Member Functions
	ConstRespectingPtr (ConstRespectingPtr< T > const &)=delete
ConstRespectingPtr &	operator= (ConstRespectingPtr< T > const &)=delete

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 56 of file ConstRespectingPtr.h.

: m_data(nullptr) {}

ConstRespectingPtr() [2/3]

template<typename T>

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

explicit

Definition at line 59 of file ConstRespectingPtr.h.

: m_data(v) {}

~ConstRespectingPtr()

template<typename T >

edm::ConstRespectingPtr< T >::~ConstRespectingPtr

(

)

Definition at line 62 of file ConstRespectingPtr.h.

                                             {
    delete m_data.get();
  }

ConstRespectingPtr() [3/3]

template<typename T>

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

privatedelete

Member Function Documentation

get() [1/2]

template<typename T>

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

inline

Definition at line 39 of file ConstRespectingPtr.h.

{ return m_data; }

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().

get() [2/2]

template<typename T>

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

inline

Definition at line 35 of file ConstRespectingPtr.h.

{ return m_data; }

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().

isSet()

template<typename T >

bool edm::ConstRespectingPtr< T >::isSet

(

)

const

Definition at line 67 of file ConstRespectingPtr.h.

                                          {
    return nullptr != m_data;
  }

operator*() [1/2]

template<typename T>

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

inline

Definition at line 38 of file ConstRespectingPtr.h.

{ return *m_data; }

operator*() [2/2]

template<typename T>

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

inline

Definition at line 34 of file ConstRespectingPtr.h.

{ return *m_data; }

operator->() [1/2]

template<typename T>

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

inline

Definition at line 37 of file ConstRespectingPtr.h.

{ return m_data; }

operator->() [2/2]

template<typename T>

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

inline

Definition at line 33 of file ConstRespectingPtr.h.

{ return m_data; }

operator=()

template<typename T>

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

privatedelete

release()

template<typename T >

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

(

)

Definition at line 78 of file ConstRespectingPtr.h.

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

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

reset()

template<typename T >

void edm::ConstRespectingPtr< T >::reset

(

void

)

Definition at line 85 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 72 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 52 of file ConstRespectingPtr.h.

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