details::PointerToData_t< T > Class Template Reference

Public Types
using	value_type = T
using	const_value_type = std::add_const_t< value_type >
using	reference = std::add_lvalue_reference_t< value_type >
using	const_reference = std::add_lvalue_reference_t< const_value_type >
using	pointer = std::add_pointer_t< value_type >
using	const_pointer = std::add_pointer_t< const_value_type >

Public Member Functions
	~PointerToData_t ()
	Destructor: gets rid of the owned data. More...
	operator bool () const
	Returns whether we point to something. More...
bool	operator! () const
	Returns whether we point to nothing. More...
bool	hasData () const
	Returns whether we have data. More...
bool	owned () const
	Returns whether we have data and we own it. More...
void	SetData (pointer data, bool owned)
	Sets the data and the ownership. More...
void	AcquireData (pointer data)
	Acquire ownership of the specified data. More...
void	PointToData (pointer data)
	Point to the specified data, not acquiring ownership. More...
void	PointToData (reference data)
	Point to the specified data, not acquiring ownership. More...
void	StealData (std::remove_const_t< T > &&data)
	Move data from the specified object, and own it. More...
void	NewData (T const &data)
	Create a owned copy of the specified object. More...
void	Clear ()
	Stop pointing to the data; if owned, delete it. More...
Dereferencing
const_reference	operator* () const
reference	operator* ()
const_pointer	operator-> () const
pointer	operator-> ()

Protected Attributes
bool	bOwned = false
	whether we own our data More...
pointer	pData = nullptr
	pointer to data More...

Detailed Description

template<typename T>
class details::PointerToData_t< T >

Todo:

Document this code and make it into a library

Definition at line 108 of file RawDataDrawer.cxx.

Member Typedef Documentation

template<typename T >

using details::PointerToData_t< T >::const_pointer = std::add_pointer_t<const_value_type>

Definition at line 115 of file RawDataDrawer.cxx.

template<typename T >

using details::PointerToData_t< T >::const_reference = std::add_lvalue_reference_t<const_value_type>

Definition at line 113 of file RawDataDrawer.cxx.

template<typename T >

using details::PointerToData_t< T >::const_value_type = std::add_const_t<value_type>

Definition at line 111 of file RawDataDrawer.cxx.

template<typename T >

using details::PointerToData_t< T >::pointer = std::add_pointer_t<value_type>

Definition at line 114 of file RawDataDrawer.cxx.

template<typename T >

using details::PointerToData_t< T >::reference = std::add_lvalue_reference_t<value_type>

Definition at line 112 of file RawDataDrawer.cxx.

template<typename T >

using details::PointerToData_t< T >::value_type = T

Definition at line 110 of file RawDataDrawer.cxx.

Constructor & Destructor Documentation

template<typename T >

details::PointerToData_t< T >::~PointerToData_t ( )

inline

Destructor: gets rid of the owned data.

Definition at line 118 of file RawDataDrawer.cxx.

{ Clear(); }

Member Function Documentation

template<typename T >

void details::PointerToData_t< T >::AcquireData ( pointer  data )

inline

Acquire ownership of the specified data.

Definition at line 159 of file RawDataDrawer.cxx.

    {
      SetData(data, true);
    }

template<typename T >

void details::PointerToData_t< T >::Clear ( void  )

inline

Stop pointing to the data; if owned, delete it.

Definition at line 189 of file RawDataDrawer.cxx.

    {
      if (bOwned) delete pData;
      pData = nullptr;
      bOwned = false;
    } // Clear()

template<typename T >

bool details::PointerToData_t< T >::hasData ( ) const

inline

Returns whether we have data.

Definition at line 137 of file RawDataDrawer.cxx.

    {
      return bool(pData);
    }

template<typename T >

void details::PointerToData_t< T >::NewData ( T const &  data )

inline

Create a owned copy of the specified object.

Definition at line 183 of file RawDataDrawer.cxx.

    {
      AcquireData(new T(data));
    }

template<typename T >

details::PointerToData_t< T >::operator bool ( ) const

inline

Returns whether we point to something.

Definition at line 130 of file RawDataDrawer.cxx.

{ return hasData(); }

template<typename T >

bool details::PointerToData_t< T >::operator! ( ) const

inline

Returns whether we point to nothing.

Definition at line 133 of file RawDataDrawer.cxx.

{ return !hasData(); }

template<typename T >

const_reference details::PointerToData_t< T >::operator* ( ) const

inline

Definition at line 122 of file RawDataDrawer.cxx.

{ return *pData; }

template<typename T >

reference details::PointerToData_t< T >::operator* ( )

inline

Definition at line 123 of file RawDataDrawer.cxx.

{ return *pData; }

template<typename T >

const_pointer details::PointerToData_t< T >::operator-> ( ) const

inline

Definition at line 125 of file RawDataDrawer.cxx.

{ return pData; }

template<typename T >

pointer details::PointerToData_t< T >::operator-> ( )

inline

Definition at line 126 of file RawDataDrawer.cxx.

{ return pData; }

template<typename T >

bool details::PointerToData_t< T >::owned ( ) const

inline

Returns whether we have data and we own it.

Definition at line 144 of file RawDataDrawer.cxx.

    {
      return bOwned && hasData();
    }

template<typename T >

void details::PointerToData_t< T >::PointToData ( pointer  data )

inline

Point to the specified data, not acquiring ownership.

Definition at line 165 of file RawDataDrawer.cxx.

    {
      SetData(data, false);
    }

template<typename T >

void details::PointerToData_t< T >::PointToData ( reference  data )

inline

Point to the specified data, not acquiring ownership.

Definition at line 171 of file RawDataDrawer.cxx.

    {
      SetData(&data, false);
    }

template<typename T >

void details::PointerToData_t< T >::SetData ( pointer  data, bool  owned  )

inline

Sets the data and the ownership.

Definition at line 151 of file RawDataDrawer.cxx.

    {
      Clear();
      bOwned = owned;
      pData = data;
    }

template<typename T >

void details::PointerToData_t< T >::StealData ( std::remove_const_t< T > &&  data )

inline

Move data from the specified object, and own it.

Definition at line 177 of file RawDataDrawer.cxx.

    {
      AcquireData(new T(std::move(data)));
    }

Member Data Documentation

template<typename T >

bool details::PointerToData_t< T >::bOwned = false

protected

whether we own our data

Definition at line 197 of file RawDataDrawer.cxx.

template<typename T >

pointer details::PointerToData_t< T >::pData = nullptr

protected

pointer to data

Definition at line 198 of file RawDataDrawer.cxx.

---

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

• lareventdisplay/lareventdisplay/EventDisplay/RawDataDrawer.cxx