allpix::Object

Module: Objects

Base class for internal objects.

#include <Object.hpp>

Inherits from TObject

Inherited by allpix::MCParticle, allpix::MCTrack, allpix::PixelCharge, allpix::PixelHit, allpix::PixelPulse, allpix::SensorCharge

Public Classes

	Name
class	BaseWrapper
class	PointerWrapper

Public Functions

	Name
	Object(const Object & ) =default Use default copy behaviour.
Object &	operator=(const Object & ) =default Use default copy behaviour.
	Object(Object && ) =default Use default move behaviour.
Object &	operator=(Object && ) =default Use default move behaviour.
	Object() =default Required default constructor.
	~Object() override =default Required virtual destructor.
	ClassDefOverride(Object , 4 ) ROOT class definition.
virtual void	loadHistory() =0 Resolve all the history to standard pointers.
virtual void	petrifyHistory() =0 Petrify all the pointers to prepare for persistent storage.
void	markForStorage()

Protected Functions

	Name
virtual void	print(std::ostream & out) const Print an ASCII representation of this Object to the given stream.
void	Print(Option_t * ) const override Override function to implement ROOT Print()

Friends

	Name
std::ostream &	operator«(std::ostream & out, const allpix::Object & obj) Overloaded ostream operator for printing of object data.

Public Functions Documentation

function Object

Object(
    const Object & 
) =default

Use default copy behaviour.

function operator=

Object & operator=(
    const Object & 
) =default

Use default copy behaviour.

function Object

Object(
    Object && 
) =default

Use default move behaviour.

function operator=

Object & operator=(
    Object && 
) =default

Use default move behaviour.

function Object

Object() =default

Required default constructor.

function ~Object

~Object() override =default

Required virtual destructor.

function ClassDefOverride

ClassDefOverride(
    Object ,
    4 
)

ROOT class definition.

function loadHistory

virtual void loadHistory() =0

Resolve all the history to standard pointers.

Reimplemented by: allpix::DepositedCharge::loadHistory, allpix::MCParticle::loadHistory, allpix::MCTrack::loadHistory, allpix::PixelCharge::loadHistory, allpix::PixelHit::loadHistory, allpix::PixelPulse::loadHistory, allpix::PropagatedCharge::loadHistory

function petrifyHistory

virtual void petrifyHistory() =0

Petrify all the pointers to prepare for persistent storage.

Reimplemented by: allpix::DepositedCharge::petrifyHistory, allpix::MCParticle::petrifyHistory, allpix::MCTrack::petrifyHistory, allpix::PixelCharge::petrifyHistory, allpix::PixelHit::petrifyHistory, allpix::PixelPulse::petrifyHistory, allpix::PropagatedCharge::petrifyHistory

function markForStorage

inline void markForStorage()

Protected Functions Documentation

function print

inline virtual void print(
    std::ostream & out
) const

Print an ASCII representation of this Object to the given stream.

Parameters:

out Stream to print to

Reimplemented by: allpix::DepositedCharge::print, allpix::MCParticle::print, allpix::MCTrack::print, allpix::PixelCharge::print, allpix::PixelHit::print, allpix::PixelPulse::print, allpix::PropagatedCharge::print, allpix::SensorCharge::print

function Print

inline void Print(
    Option_t * 
) const override

Override function to implement ROOT Print()

Warning: Should not be used inside the framework but might assist in inspecting ROOT files with these objects.

Friends

friend operator«

friend std::ostream & operator<<(
    std::ostream & out,

    const allpix::Object & obj
);

Overloaded ostream operator for printing of object data.

Parameters:

out Stream to write output to
obj Object to print to stream

Return: Stream where output was written to

Updated on 2024-12-13 at 08:31:36 +0000