All classes that their objects may be contained in an LHCb ObjectContainer (e.g. More...

#include <GaudiKernel/ContainedObject.h>

Inheritance diagram for ContainedObject:

Collaboration diagram for ContainedObject:

[legend]

Public Member Functions
virtual const CLID &	clID () const
	Retrieve pointer to class identifier. More...

const ObjectContainerBase *	parent () const
	Access to parent object. More...

void	setParent (ObjectContainerBase *value)
	Update parent member. More...

virtual long	index () const
	Distance in the parent container. More...

virtual StreamBuffer &	serialize (StreamBuffer &s) const
	Serialize the object for writing. More...

virtual StreamBuffer &	serialize (StreamBuffer &s)
	Serialize the object for reading. More...

virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII) More...

Static Public Member Functions
static const CLID &	classID ()

Protected Member Functions
	ContainedObject ()=default
	Constructors. More...

	ContainedObject (const ContainedObject &)
	Copy constructor – do NOT copy the parent reference... More...

virtual	~ContainedObject ()
	Destructor. More...

Private Attributes
ObjectContainerBase *	m_parent = nullptr
	Pointer to the parent. More...

Friends
class	ObjectVector< ContainedObject >
	Allow the container classes access to protected members. More...

class	ObjectList< ContainedObject >

std::ostream &	operator<< (std::ostream &s, const ContainedObject &obj)
	Output operator (ASCII) More...

Detailed Description

All classes that their objects may be contained in an LHCb ObjectContainer (e.g.

ObjectVector, or ObjectList), have to inherit from the class ContainedObject. It guarantees the navigability from the contained object back to its container.

Author: Pavel Binko

Definition at line 31 of file ContainedObject.h.

Constructor & Destructor Documentation

ContainedObject::ContainedObject ( )

protecteddefault

Constructors.

ContainedObject::ContainedObject ( const ContainedObject & )

inlineprotected

Copy constructor – do NOT copy the parent reference...

Definition at line 42 of file ContainedObject.h.

42 : ContainedObject() {}

ContainedObject::ContainedObject

ContainedObject()=default

Constructors.

ContainedObject::~ContainedObject ( )

protectedvirtual

Destructor.

Definition at line 3 of file ContainedObject.cpp.

 {
   // If the object is contained in a container, remove it from there
   if ( m_parent ) m_parent->remove( this );
 }

Member Function Documentation

static const CLID& ContainedObject::classID ( )

inlinestatic

Definition at line 49 of file ContainedObject.h.

49 { return CLID_ContainedObject; }

virtual const CLID& ContainedObject::clID ( ) const

inlinevirtual

Retrieve pointer to class identifier.

Definition at line 48 of file ContainedObject.h.

48 { return classID(); }

ContainedObject::classID

static const CLID & classID()

Definition: ContainedObject.h:49

virtual std::ostream& ContainedObject::fillStream ( std::ostream & s ) const

inlinevirtual

Fill the output stream (ASCII)

Definition at line 63 of file ContainedObject.h.

63 { return s; }

gaudirun.s

string s

Definition: gaudirun.py:253

virtual long ContainedObject::index ( ) const

inlinevirtual

Distance in the parent container.

Reimplemented in KeyedObject< KEY >.

Definition at line 57 of file ContainedObject.h.

57 { return m_parent ? m_parent->index( this ) : -1; }

ContainedObject::m_parent

ObjectContainerBase * m_parent

Pointer to the parent.

Definition: ContainedObject.h:69

ObjectContainerBase::index

virtual long index(const ContainedObject *obj) const =0

Distance of a given object from the beginning of its container.

const ObjectContainerBase* ContainedObject::parent ( ) const

inline

Access to parent object.

Definition at line 52 of file ContainedObject.h.

52 { return m_parent; }

ContainedObject::m_parent

ObjectContainerBase * m_parent

Pointer to the parent.

Definition: ContainedObject.h:69

virtual StreamBuffer& ContainedObject::serialize ( StreamBuffer & s ) const

inlinevirtual

Serialize the object for writing.

Reimplemented in KeyedObject< KEY >.

Definition at line 59 of file ContainedObject.h.

59 { return s; }

gaudirun.s

string s

Definition: gaudirun.py:253

virtual StreamBuffer& ContainedObject::serialize ( StreamBuffer & s )

inlinevirtual

Serialize the object for reading.

Reimplemented in KeyedObject< KEY >.

Definition at line 61 of file ContainedObject.h.

61 { return s; }

gaudirun.s

string s

Definition: gaudirun.py:253

void ContainedObject::setParent ( ObjectContainerBase * value )

inline

Update parent member.

Definition at line 54 of file ContainedObject.h.

54 { m_parent = value; }

ContainedObject::m_parent

ObjectContainerBase * m_parent

Pointer to the parent.

Definition: ContainedObject.h:69

Friends And Related Function Documentation

friend class ObjectList< ContainedObject >

friend

Definition at line 36 of file ContainedObject.h.

friend class ObjectVector< ContainedObject >

friend

Allow the container classes access to protected members.

Definition at line 35 of file ContainedObject.h.

std::ostream& operator<<	(	std::ostream &	s,
		const ContainedObject &	obj
	)

friend

Output operator (ASCII)

Definition at line 65 of file ContainedObject.h.

65 { return obj.fillStream( s ); }

ContainedObject::fillStream

virtual std::ostream & fillStream(std::ostream &s) const

Fill the output stream (ASCII)

Definition: ContainedObject.h:63

Member Data Documentation

ObjectContainerBase* ContainedObject::m_parent = nullptr

private

Pointer to the parent.

Definition at line 69 of file ContainedObject.h.

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

GaudiKernel/GaudiKernel/ContainedObject.h
GaudiKernel/src/Lib/ContainedObject.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation