DataObject Class Reference

#include <GaudiKernel/DataObject.h>

Inheritance diagram for DataObject:

Collaboration diagram for DataObject:

Public Member Functions
	DataObject ()
	Standard Constructor. More...
	DataObject (const DataObject &rhs)
	Copy Constructor. More...
DataObject &	operator= (const DataObject &rhs)
	Assignment Operator. More...
	DataObject (DataObject &&rhs)
	Move Constructor. More...
DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator. More...
virtual	~DataObject ()
	Standard Destructor. More...
virtual unsigned long	addRef ()
	Add reference to object. More...
virtual unsigned long	release ()
	release reference to object More...
virtual const CLID &	clID () const
	Retrieve reference to class definition structure. More...
const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store. More...
virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback. More...

Static Public Member Functions
static const CLID &	classID ()
	Retrieve reference to class definition structure (static access) More...

Private Attributes
std::atomic< unsigned long >	m_refCount = 0
	Reference count. More...
unsigned char	m_version = 0
	Version number. More...
IRegistry *	m_pRegistry = nullptr
	Pointer to the Registry Object. More...
std::unique_ptr< LinkManager >	m_pLinkMgr
	Store of symbolic links. More...

inline code of class DataObject
void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry. More...
IRegistry *	registry () const
	Get pointer to Registry. More...
LinkManager *	linkMgr ()
	Retrieve Link manager. More...
const LinkManager *	linkMgr () const
unsigned char	version () const
	Retrieve version number of this object representation. More...
void	setVersion (unsigned char vsn)
	Set version number of this object representation. More...
unsigned long	refCount () const
	Return the refcount. More...
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII) More...
std::ostream &	operator<< (std::ostream &s, const DataObject &obj)
	Output operator (ASCII) More...

Detailed Description

A DataObject is the base class of any identifiable object on any data store. The base class supplies the implementation of data streaming.

Author

M.Frank

Definition at line 37 of file DataObject.h.

Constructor & Destructor Documentation

DataObject() [1/3]

DataObject::DataObject

(

)

Standard Constructor.

Definition at line 23 of file DataObject.cpp.

: m_pLinkMgr{ new LinkManager() } {}

DataObject() [2/3]

DataObject::DataObject

(

const DataObject &

rhs

)

Copy Constructor.

Definition at line 26 of file DataObject.cpp.

: m_version{ rhs.m_version }, m_pLinkMgr{ new LinkManager() } {}

DataObject() [3/3]

DataObject::DataObject

(

DataObject &&

rhs

)

Move Constructor.

Definition at line 36 of file DataObject.cpp.

    : m_version{ std::move( rhs.m_version ) }, m_pLinkMgr{ std::move( rhs.m_pLinkMgr ) } {}

~DataObject()

DataObject::~DataObject ( )

virtual

Standard Destructor.

Definition at line 47 of file DataObject.cpp.

                        {
  // Issue a warning if the object is being deleted and the reference
  // count is non-zero.
  if ( m_refCount > 0 ) {
    // Insert warning here
  }
}

Member Function Documentation

addRef()

unsigned long DataObject::addRef ( )

virtual

Add reference to object.

Definition at line 63 of file DataObject.cpp.

{ return ++m_refCount; }

classID()

const CLID & DataObject::classID ( )

static

Retrieve reference to class definition structure (static access)

Retrieve Pointer to class definition structure.

Definition at line 69 of file DataObject.cpp.

{ return CLID_DataObject; }

clID()

const CLID & DataObject::clID ( ) const

virtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented in NTuple::File, NTuple::Directory, KeyedContainer< DATATYPE, MAPPING >, NTuple::RowWiseTuple, NTuple::ColumnWiseTuple, SharedObjectsContainer< TYPE >, AlgorithmHistory, Gaudi::Histogram1D, JobHistory, AlgToolHistory, Gaudi::Histogram3D, Gaudi::Histogram2D, Gaudi::Profile2D, Gaudi::Profile1D, DataHistory, Gaudi::TestSuite::Event, ServiceHistory, Gaudi::TestSuite::Counter, HistoryObj, and Gaudi::TestSuite::Collision.

Definition at line 66 of file DataObject.cpp.

{ return CLID_DataObject; }

fillStream()

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

virtual

Fill the output stream (ASCII)

Reimplemented in Gaudi::TestSuite::Event.

Definition at line 77 of file DataObject.cpp.

                                                        {
  boost::io::ios_flags_saver _{ s };
  return s << "DataObject at " << std::hex << this;
}

linkMgr() [1/2]

LinkManager* DataObject::linkMgr ( )

inline

Retrieve Link manager.

Definition at line 81 of file DataObject.h.

{ return m_pLinkMgr.get(); }

linkMgr() [2/2]

const LinkManager* DataObject::linkMgr ( ) const

inline

Definition at line 82 of file DataObject.h.

{ return m_pLinkMgr.get(); }

name()

const std::string & DataObject::name

(

)

const

Retreive DataObject name. It is the name when registered in the store.

Retrieve DataObject name. It is the name when included in the store.

Definition at line 72 of file DataObject.cpp.

{ return m_pRegistry ? m_pRegistry->name() : _sDataObjectCppNotRegistered; }

operator=() [1/2]

DataObject & DataObject::operator=

(

const DataObject &

rhs

)

Assignment Operator.

Definition at line 29 of file DataObject.cpp.

                                                         {
  m_version = rhs.m_version;
  m_pLinkMgr.reset( new LinkManager() );
  return *this;
}

operator=() [2/2]

DataObject & DataObject::operator=

(

DataObject &&

rhs

)

Move Assignment Operator.

Assignment Operator.

Definition at line 40 of file DataObject.cpp.

                                                    {
  m_version  = std::move( rhs.m_version );
  m_pLinkMgr = std::move( rhs.m_pLinkMgr );
  return *this;
}

refCount()

unsigned long DataObject::refCount ( ) const

inline

Return the refcount.

Definition at line 88 of file DataObject.h.

{ return m_refCount; }

registry()

IRegistry* DataObject::registry ( ) const

inline

Get pointer to Registry.

Definition at line 79 of file DataObject.h.

{ return m_pRegistry; }

release()

unsigned long DataObject::release ( )

virtual

release reference to object

Decrease reference count.

Definition at line 56 of file DataObject.cpp.

                                  {
  unsigned long cnt = --m_refCount;
  if ( 0 == cnt ) delete this;
  return cnt;
}

setRegistry()

void DataObject::setRegistry ( IRegistry *  pRegistry )

inline

Set pointer to Registry.

Definition at line 77 of file DataObject.h.

{ m_pRegistry = pRegistry; }

setVersion()

void DataObject::setVersion ( unsigned char  vsn )

inline

Set version number of this object representation.

Definition at line 86 of file DataObject.h.

{ m_version = vsn; }

update()

StatusCode DataObject::update ( )

virtual

Provide empty placeholder for internal object reconfiguration callback.

Reimplemented in KeyedContainer< DATATYPE, MAPPING >, KeyedContainer< Gaudi::TestSuite::MyVertex >, and KeyedContainer< Gaudi::TestSuite::MyTrack >.

Definition at line 75 of file DataObject.cpp.

{ return StatusCode::SUCCESS; }

version()

unsigned char DataObject::version ( ) const

inline

Retrieve version number of this object representation.

Definition at line 84 of file DataObject.h.

{ return m_version; }

Friends And Related Function Documentation

operator<<

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

friend

Output operator (ASCII)

Definition at line 92 of file DataObject.h.

{ return obj.fillStream( s ); }

Member Data Documentation

m_pLinkMgr

std::unique_ptr<LinkManager> DataObject::m_pLinkMgr

private

Store of symbolic links.

Definition at line 46 of file DataObject.h.

m_pRegistry

IRegistry* DataObject::m_pRegistry = nullptr

private

Pointer to the Registry Object.

Definition at line 44 of file DataObject.h.

m_refCount

std::atomic<unsigned long> DataObject::m_refCount = 0

private

Reference count.

Definition at line 40 of file DataObject.h.

m_version

unsigned char DataObject::m_version = 0

private

Version number.

Definition at line 42 of file DataObject.h.

---

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

• GaudiKernel/include/GaudiKernel/DataObject.h
• GaudiKernel/src/Lib/DataObject.cpp