Athena::DataBucketBranch Class Reference

#include <RootDataBucketBranch.h>

Inheritance diagram for Athena::DataBucketBranch:

Collaboration diagram for Athena::DataBucketBranch:

Public Member Functions
	DataBucketBranch (CLID clid, const std::string &type_name, void *ptr=NULL)
	DataBucketBranch (CLID clid, const std::type_info &ti, void *ptr=NULL)
	DataBucketBranch (CLID clid, const RootType &type, void *ptr)
virtual	~DataBucketBranch () override
virtual void *	object () override
virtual void *	cast (CLID clid, SG::IRegisterTransient *itr, bool isConst=true) override
	Return the contents of the DataBucket, converted to type given by clid.
virtual void *	cast (const std::type_info &tinfo, SG::IRegisterTransient *itr, bool isConst=true) override
	Return the contents of the DataBucket, converted to type given by std::type_info.
virtual void	relinquish () override
	Give up ownership of the DataBucket contents.
virtual void	lock () override
	If the held object derives from ILockable, call lock() on it.
virtual const CLID &	clID () const override
virtual const std::type_info &	tinfo () const override
	Return the type_info for the stored object.
template<class T>
T *	cast (SG::IRegisterTransient *irt=0, bool isConst=true)
	Return the contents of the DataBucket, converted to type T.
virtual void *	cast (CLID clid, const std::type_info &tinfo, SG::IRegisterTransient *irt=0, bool isConst=true)
	Return the contents of the DataBucket, converted to type given by clid.

Public Attributes
CLID	m_clid
RootType	m_type
void *	m_ptr
bool	allowMismatchCLID =false

Detailed Description

Definition at line 24 of file RootDataBucketBranch.h.

Constructor & Destructor Documentation

DataBucketBranch() [1/3]

Athena::DataBucketBranch::DataBucketBranch ( CLID clid, const std::string & type_name, void * ptr = NULL )

inline

Definition at line 28 of file RootDataBucketBranch.h.

                                     :
    m_clid(clid),
    m_type(RootType(type_name)),
    m_ptr(ptr)
  {}

DataBucketBranch() [2/3]

Athena::DataBucketBranch::DataBucketBranch ( CLID clid, const std::type_info & ti, void * ptr = NULL )

inline

Definition at line 36 of file RootDataBucketBranch.h.

                                     :
    m_clid(clid),
    m_type(RootType(ti)),
    m_ptr(ptr)
  {}

DataBucketBranch() [3/3]

Athena::DataBucketBranch::DataBucketBranch ( CLID clid, const RootType & type, void * ptr )

inline

Definition at line 44 of file RootDataBucketBranch.h.

                                                               :
    m_clid(clid),
    m_type(type),
    m_ptr(ptr)
  {}

~DataBucketBranch()

Athena::DataBucketBranch::~DataBucketBranch ( )

overridevirtual

Definition at line 21 of file RootDataBucketBranch.cxx.

{
  //std::cerr << "::~DBB[" << m_clid << "," << name() << "]\n";
}

Member Function Documentation

cast() [1/4]

virtual void * DataBucketBase::cast ( CLID clid, const std::type_info & tinfo, SG::IRegisterTransient * irt = 0, bool isConst = true )

virtual

Return the contents of the DataBucket, converted to type given by clid.

Note that only derived->base conversions are allowed here.

Parameters

clid	The class ID to which to convert.
tinfo	The std::type_info of the type to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

This allows the callee to choose whether to use clid or tinfo. By default, this uses type_info.

Reimplemented from DataBucketBase.

cast() [2/4]

void * Athena::DataBucketBranch::cast ( CLID clid, SG::IRegisterTransient * irt, bool isConst = true )

overridevirtual

Return the contents of the DataBucket, converted to type given by clid.

Note that only derived->base conversions are allowed here.

Parameters

clid	The class ID to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

Implements DataBucketBase.

Definition at line 27 of file RootDataBucketBranch.cxx.

{
  // no conversion needed
  if (allowMismatchCLID || clid == m_clid) {
    return m_ptr;
 
  } else {
    std::ostringstream err;
    err << "cannot convert from clid [" 
        << this->clID()
        << "] to requested ["
        << clid
        << "]";
    throw std::runtime_error(err.str());
  }
  return 0;
}

cast() [3/4]

void * Athena::DataBucketBranch::cast ( const std::type_info & tinfo, SG::IRegisterTransient * irt, bool isConst = true )

overridevirtual

Return the contents of the DataBucket, converted to type given by std::type_info.

Note that only derived->base conversions are allowed here.

Parameters

tinfo	The std::type_info of the type to which to convert.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

Implements DataBucketBase.

Definition at line 47 of file RootDataBucketBranch.cxx.

{
  return m_ptr;
}

cast() [4/4]

template<class T>

T * DataBucketBase::cast	(	SG::IRegisterTransient *	irt = 0,
		bool	isConst = true )

Return the contents of the DataBucket, converted to type T.

Note that only derived->base conversions are allowed here. T must have a valid Class ID for this to work.

Parameters

irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

clID()

virtual const CLID & Athena::DataBucketBranch::clID ( ) const

inlineoverridevirtual

Definition at line 71 of file RootDataBucketBranch.h.

{ return m_clid; }

lock()

void Athena::DataBucketBranch::lock ( )

inlineoverridevirtual

If the held object derives from ILockable, call lock() on it.

Implements DataBucketBase.

Definition at line 101 of file RootDataBucketBranch.h.

{}

object()

void * Athena::DataBucketBranch::object ( )

inlineoverridevirtual

Implements DataBucketBase.

Definition at line 89 of file RootDataBucketBranch.h.

{
  return m_ptr;
}

relinquish()

void Athena::DataBucketBranch::relinquish ( )

inlineoverridevirtual

Give up ownership of the DataBucket contents.

This leaks the contents and it is useful mainly for error handling.

Implements DataBucketBase.

Definition at line 96 of file RootDataBucketBranch.h.

{}

tinfo()

virtual const std::type_info & Athena::DataBucketBranch::tinfo ( ) const

inlineoverridevirtual

Return the type_info for the stored object.

Implements DataBucketBase.

Definition at line 73 of file RootDataBucketBranch.h.

  {
    return m_type.TypeInfo();
  }

Member Data Documentation

allowMismatchCLID

bool Athena::DataBucketBranch::allowMismatchCLID =false

Definition at line 83 of file RootDataBucketBranch.h.

m_clid

CLID Athena::DataBucketBranch::m_clid

Definition at line 79 of file RootDataBucketBranch.h.

m_ptr

void* Athena::DataBucketBranch::m_ptr

Definition at line 81 of file RootDataBucketBranch.h.

m_type

RootType Athena::DataBucketBranch::m_type

Definition at line 80 of file RootDataBucketBranch.h.

---

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

• RootDataBucketBranch.h
• RootDataBucketBranch.cxx