allpix::Object::BaseWrapper
#include <Object.hpp>
Inherited by allpix::Object::PointerWrapper< T >
Public Functions
Name | |
---|---|
BaseWrapper(const BaseWrapper & rhs) =default Use default copy behaviour. |
|
BaseWrapper & | operator=(const BaseWrapper & rhs) =default Use default copy behaviour. |
BaseWrapper(BaseWrapper && rhs) =default Use default move behaviour. |
|
BaseWrapper & | operator=(BaseWrapper && rhs) =default Use default move behaviour. |
BaseWrapper() =default Required default constructor. |
|
BaseWrapper(const T * obj) Constructor with object pointer to be wrapped. |
|
virtual T * | get() const =0 Getter function to retrieve pointer from wrapper object. |
void | store() Function to construct TRef object for wrapped pointer for persistent storage. |
ClassDef(BaseWrapper , 1 ) |
Protected Functions
Name | |
---|---|
virtual | ~BaseWrapper() =default Required virtual destructor. |
bool | markedForStorage() const Helper to determine whether the pointed object will be stored. |
Protected Attributes
Name | |
---|---|
T * | ptr_ |
TRef | ref_ transient value |
Detailed Description
template <class T >
class allpix::Object::BaseWrapper;
Public Functions Documentation
function BaseWrapper
BaseWrapper(
const BaseWrapper & rhs
) =default
Use default copy behaviour.
function operator=
BaseWrapper & operator=(
const BaseWrapper & rhs
) =default
Use default copy behaviour.
function BaseWrapper
BaseWrapper(
BaseWrapper && rhs
) =default
Use default move behaviour.
function operator=
BaseWrapper & operator=(
BaseWrapper && rhs
) =default
Use default move behaviour.
function BaseWrapper
BaseWrapper() =default
Required default constructor.
function BaseWrapper
inline explicit BaseWrapper(
const T * obj
)
Constructor with object pointer to be wrapped.
Parameters:
- obj Pointer to object
function get
virtual T * get() const =0
Getter function to retrieve pointer from wrapper object.
Return: Pointer to object
Reimplemented by: allpix::Object::PointerWrapper::get
This function implements lazy loading and fetches the pointer from the TRef object in case the pointer is not initialized yet
function store
inline void store()
Function to construct TRef object for wrapped pointer for persistent storage.
Note: A TRef is only constructed if the object the wrapped pointer is referring to has been marked for storage
function ClassDef
ClassDef(
BaseWrapper ,
1
)
Protected Functions Documentation
function ~BaseWrapper
virtual ~BaseWrapper() =default
Required virtual destructor.
function markedForStorage
inline bool markedForStorage() const
Helper to determine whether the pointed object will be stored.
Return: True if object will be stored, false otherwise
Protected Attributes Documentation
variable ptr_
T * ptr_ {};
variable ref_
TRef ref_ {};
transient value
Updated on 2025-02-27 at 14:14:46 +0000