DataBucketBase Class Reference

A non-templated base class for DataBucket, allows to access the transient object address as a void*. More...

#include <DataBucketBase.h>

Inheritance diagram for DataBucketBase:

Collaboration diagram for DataBucketBase:

Public Member Functions
	DataBucketBase ()
virtual	~DataBucketBase ()
virtual void *	object ()=0
virtual const std::type_info &	tinfo () const =0
	Return the type_info for the stored object. More...
template<class T >
T *	cast (SG::IRegisterTransient *irt=0, bool isConst=true)
	Return the contents of the DataBucket, converted to type T. More...
virtual void *	cast (CLID clid, SG::IRegisterTransient *irt=0, bool isConst=true)=0
	Return the contents of the DataBucket, converted to type given by clid. More...
virtual void *	cast (const std::type_info &tinfo, SG::IRegisterTransient *irt=0, bool isConst=true)=0
	Return the contents of the DataBucket, converted to type given by std::type_info. More...
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. More...
virtual void	relinquish ()=0
	Give up ownership of the DataBucket contents. More...
virtual void	lock ()=0
	If the held object derives from ILockable, call lock() on it. More...

Detailed Description

A non-templated base class for DataBucket, allows to access the transient object address as a void*.

Author

ATLAS Collaboration

Id

DataBucketBase.h,v 1.7 2008-05-30 22:58:46 calaf Exp

Definition at line 23 of file DataBucketBase.h.

Constructor & Destructor Documentation

DataBucketBase()

DataBucketBase::DataBucketBase ( )

inline

Definition at line 28 of file DataBucketBase.h.

{ };

~DataBucketBase()

virtual DataBucketBase::~DataBucketBase ( )

inlinevirtual

Definition at line 29 of file DataBucketBase.h.

{ };

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 in xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, SG::DataBucket< T >, SG::DataBucket< DV >, and SG::MetaContDataBucket< T >.

cast() [2/4]

virtual void* DataBucketBase::cast ( CLID  clid, SG::IRegisterTransient *  irt = 0, bool  isConst = true  )

pure 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.
irt	To be called if we make a new instance.
isConst	True if the object being converted is regarded as const.

Implemented in SG::SymlinkDataObject, xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, Athena::DataBucketBranch, BareDataBucket, SG::PyDataBucket, SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, SG::DataBucket< T >, SG::DataBucket< DV >, and SG::MetaContDataBucket< T >.

cast() [3/4]

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

pure virtual

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.

Implemented in Athena::DataBucketBranch, BareDataBucket, xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, SG::PyDataBucket, SG::DVLDataBucket< T >, SG::DVLDataBucket< DV >, SG::DataBucket< T >, SG::DataBucket< DV >, SG::MetaContDataBucket< T >, and SG::SymlinkDataObject.

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.

lock()

virtual void DataBucketBase::lock ( )

pure virtual

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

Implemented in SG::PyDataBucket, xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, SG::DataBucket< T >, SG::DataBucket< DV >, SG::SymlinkDataObject, Athena::DataBucketBranch, and BareDataBucket.

object()

virtual void* DataBucketBase::object ( )

pure virtual

Implemented in SG::PyDataBucket, SG::SymlinkDataObject, xAODPrivate::THolderBucket, Athena::DataBucketBranch, xAODPrivate::HolderBucket, SG::DataBucket< T >, SG::DataBucket< DV >, and BareDataBucket.

relinquish()

virtual void DataBucketBase::relinquish ( )

pure virtual

Give up ownership of the DataBucket contents.

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

Implemented in SG::PyDataBucket, xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, SG::DataBucket< T >, SG::DataBucket< DV >, SG::SymlinkDataObject, Athena::DataBucketBranch, and BareDataBucket.

tinfo()

virtual const std::type_info& DataBucketBase::tinfo ( ) const

pure virtual

Return the type_info for the stored object.

Implemented in SG::PyDataBucket, SG::DVLDataBucket< T >, SG::SymlinkDataObject, xAODPrivate::THolderBucket, xAODPrivate::HolderBucket, Athena::DataBucketBranch, SG::DataBucket< T >, and BareDataBucket.

---

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

• DataBucketBase.h