SmartDataObjectPtr Class Reference

A small class used to access easily (and efficiently) data items residing in data stores. More...

#include <GaudiKernel/SmartDataObjectPtr.h>

Inheritance diagram for SmartDataObjectPtr:

Collaboration diagram for SmartDataObjectPtr:

Classes
class	ObjectFinder
	Helper class to configure smart pointer functionality. More...
class	ObjectLoader
	Helper class to configure smart pointer functionality. More...

Public Types
using	AccessFunction = DataObject *(*)(SmartDataObjectPtr *ptr)

Public Member Functions
	SmartDataObjectPtr (AccessFunction access, IDataProviderSvc *pService, IRegistry *pDir, std::string path)
	Standard constructor: Construct an SmartDataObjectPtr instance. More...
	SmartDataObjectPtr (const SmartDataObjectPtr &)=default
	Copy constructor: Construct an copy of a SmartDataStorePtr instance. More...
virtual	~SmartDataObjectPtr ()=default
	Standard Destructor. More...
virtual SmartDataObjectPtr &	operator= (const SmartDataObjectPtr &)
	Assignment operator. More...
	operator IRegistry * ()
	Automatic conversion to data directory. More...
const std::string &	path () const
	Path name. More...
IRegistry *	directory ()
	Access to data directory. More...
void	setService (IDataProviderSvc *svc)
	Assign data service. More...
IDataProviderSvc *	service ()
	Retrieve data service. More...
const StatusCode &	getLastError () const
	Access to potential errors during data accesses. More...
DataObject *	accessData ()
	Static Object retrieval method: must call specific function. More...
DataObject *	retrieveObject ()
	Object retrieve method. More...
DataObject *	findObject ()
	Object find method. More...
DataObject *	updateObject ()
	Object update method. More...

Static Public Member Functions
static DataObject *	retrieve (SmartDataObjectPtr *ptr)
	Static Object retrieval method. More...
static DataObject *	find (SmartDataObjectPtr *ptr)
	Static Object find method. More...
static DataObject *	update (SmartDataObjectPtr *ptr)
	Static Object update method. More...

Protected Member Functions
StatusCode	find (IRegistry *pDirectory, const std::string &path, DataObject *&refpObject)
	Find the specified object from the data store. More...
StatusCode	find (const std::string &fullPath, DataObject *&refpObject)
	Find the specified object from the data store. More...
StatusCode	retrieve (IRegistry *pDirectory, const std::string &path, DataObject *&refpObject)
	Retrieve the specified object from the data store. More...
StatusCode	retrieve (const std::string &fullPath, DataObject *&refpObject)
	Retrieve the specified object from the data store. More...
StatusCode	update (IRegistry *pDirectory)
	Update the specified object from the data store. More...
StatusCode	update (const std::string &fullPath)
	Update the specified object from the data store. More...

Protected Attributes
IDataProviderSvc *	m_dataProvider = nullptr
	Pointer to contained object. More...
IRegistry *	m_pRegistry = nullptr
	Pointer to the data registry containing the object. More...
StatusCode	m_status = {StatusCode::SUCCESS, true}
	Keep track of the last error. More...
std::string	m_path
	Path to object. More...
AccessFunction	m_accessFunc
	Data access function. More...

Detailed Description

A small class used to access easily (and efficiently) data items residing in data stores.

The class is meant as configurable base class for real Smart pointer instances. Here mainly the access of the data store is handled. It is important to keep as less functions as possible NON-VIRTUAL in particular those, which handle the data access - they might be called very often and hence the compiler must be able to inline them.

Author

M.Frank

Version

1.0

Definition at line 32 of file SmartDataObjectPtr.h.

Member Typedef Documentation

using SmartDataObjectPtr::AccessFunction = DataObject* (*)( SmartDataObjectPtr* ptr )

Definition at line 34 of file SmartDataObjectPtr.h.

Constructor & Destructor Documentation

SmartDataObjectPtr::SmartDataObjectPtr ( AccessFunction  access, IDataProviderSvc *  pService, IRegistry *  pDir, std::string  path  )

inline

Standard constructor: Construct an SmartDataObjectPtr instance.

Parameters

svc	Pointer to the data service interface used to interact with the store.
pDir	Pointer to data directory
path	path to object relative to data directory

Definition at line 54 of file SmartDataObjectPtr.h.

      : m_dataProvider( pService ), m_pRegistry( pDir ), m_path( std::move( path ) ), m_accessFunc( access ) {}

SmartDataObjectPtr::SmartDataObjectPtr ( const SmartDataObjectPtr &  )

default

Copy constructor: Construct an copy of a SmartDataStorePtr instance.

Parameters

copy	Copy of Smart Pointer to object.

virtual SmartDataObjectPtr::~SmartDataObjectPtr ( )

virtualdefault

Standard Destructor.

Member Function Documentation

DataObject* SmartDataObjectPtr::accessData ( )

inline

Static Object retrieval method: must call specific function.

Definition at line 86 of file SmartDataObjectPtr.h.

{ return m_accessFunc( this ); }

IRegistry* SmartDataObjectPtr::directory ( )

inline

Access to data directory.

Definition at line 74 of file SmartDataObjectPtr.h.

{ return m_pRegistry; }

static DataObject* SmartDataObjectPtr::find ( SmartDataObjectPtr *  ptr )

inlinestatic

Static Object find method.

Definition at line 92 of file SmartDataObjectPtr.h.

{ return ptr->findObject(); }

StatusCode SmartDataObjectPtr::find ( IRegistry *  pDirectory, const std::string &  path, DataObject *&  refpObject  )

protected

Find the specified object from the data store.

Retrieve the object from the data store.

Parameters

pDirectory	Pointer to the directory entry holding the object.
refpObject	Reference to the pointer finally holding the object

Returns

StatusCode indicating success or failure.

Definition at line 41 of file SmartDataObjectPtr.cpp.

                                                                                                           {
  return ( m_dataProvider && pDirectory ) ? m_dataProvider->findObject( pDirectory, path, refpObject )
                                          : StatusCode::FAILURE;
  ;
}

StatusCode SmartDataObjectPtr::find ( const std::string &  fullPath, DataObject *&  refpObject  )

protected

Find the specified object from the data store.

Retrieve the object from the data store.

Parameters

fullPath	String containing the full path necessary to locate the object.
refpObject	Reference to the pointer finally holding the object

Returns

StatusCode indicating success or failure.

Definition at line 48 of file SmartDataObjectPtr.cpp.

                                                                                        {
  return m_dataProvider ? m_dataProvider->findObject( fullPath, refpObject ) : StatusCode::FAILURE;
}

DataObject * SmartDataObjectPtr::findObject

(

)

Object find method.

If the object is not known to the local object, it is requested from the data service either using the full path if there is no directory information present.

Definition at line 82 of file SmartDataObjectPtr.cpp.

                                           {
  DataObject* pObj = nullptr;
  m_status         = ( m_pRegistry ? find( m_pRegistry, m_path, pObj ) : find( m_path, pObj ) );
  if ( m_status.isSuccess() ) {
    m_pRegistry = pObj->registry();
    m_path.clear();
  }
  return pObj;
}

const StatusCode& SmartDataObjectPtr::getLastError ( ) const

inline

Access to potential errors during data accesses.

Definition at line 83 of file SmartDataObjectPtr.h.

{ return m_status; }

SmartDataObjectPtr::operator IRegistry * ( )

inline

Automatic conversion to data directory.

Definition at line 68 of file SmartDataObjectPtr.h.

{ return m_pRegistry; }

SmartDataObjectPtr & SmartDataObjectPtr::operator= ( const SmartDataObjectPtr &  copy )

virtual

Assignment operator.

Reimplemented in SmartDataStorePtr< TYPE, LOADER >, and SmartDataStorePtr< TYPE, SmartDataObjectPtr::ObjectLoader >.

Definition at line 22 of file SmartDataObjectPtr.cpp.

                                                                                  {
  m_path         = copy.m_path;
  m_pRegistry    = copy.m_pRegistry;
  m_dataProvider = copy.m_dataProvider;
  return *this;
}

const std::string& SmartDataObjectPtr::path ( ) const

inline

Path name.

Definition at line 71 of file SmartDataObjectPtr.h.

{ return m_path; }

static DataObject* SmartDataObjectPtr::retrieve ( SmartDataObjectPtr *  ptr )

inlinestatic

Static Object retrieval method.

Definition at line 89 of file SmartDataObjectPtr.h.

{ return ptr->retrieveObject(); }

StatusCode SmartDataObjectPtr::retrieve ( IRegistry *  pDirectory, const std::string &  path, DataObject *&  refpObject  )

protected

Retrieve the specified object from the data store.

Retrieve the object from the data store.

Parameters

pDirectory	Pointer to the directory entry holding the object.
refpObject	Reference to the pointer finally holding the object

Returns

StatusCode indicating success or failure.

Definition at line 30 of file SmartDataObjectPtr.cpp.

                                                                                                              {
  return ( m_dataProvider && pRegistry ) ? m_dataProvider->retrieveObject( pRegistry, path, refpObject )
                                         : StatusCode::FAILURE;
}

StatusCode SmartDataObjectPtr::retrieve ( const std::string &  fullPath, DataObject *&  refpObject  )

protected

Retrieve the specified object from the data store.

Retrieve the object from the data store.

Parameters

fullPath	String containing the full path necessary to locate the object.
refpObject	Reference to the pointer finally holding the object

Returns

StatusCode indicating success or failure.

Definition at line 36 of file SmartDataObjectPtr.cpp.

                                                                                            {
  return m_dataProvider ? m_dataProvider->retrieveObject( fullPath, refpObject ) : StatusCode::FAILURE;
}

DataObject * SmartDataObjectPtr::retrieveObject

(

)

Object retrieve method.

Object retrieval method.

If the object is not known to the local object, it is requested from the data service either using the full path if there is no directory information present.

Definition at line 67 of file SmartDataObjectPtr.cpp.

                                               {
  DataObject* pObj = nullptr;
  m_status         = ( !m_pRegistry ? retrieve( m_path, pObj ) : retrieve( m_pRegistry, m_path, pObj ) );
  if ( m_status.isSuccess() ) {
    m_pRegistry = pObj->registry();
    m_path.clear();
  }
  return pObj;
}

IDataProviderSvc* SmartDataObjectPtr::service ( )

inline

Retrieve data service.

Definition at line 80 of file SmartDataObjectPtr.h.

{ return m_dataProvider; }

void SmartDataObjectPtr::setService ( IDataProviderSvc *  svc )

inline

Assign data service.

Definition at line 77 of file SmartDataObjectPtr.h.

{ m_dataProvider = svc; }

static DataObject* SmartDataObjectPtr::update ( SmartDataObjectPtr *  ptr )

inlinestatic

Static Object update method.

Definition at line 95 of file SmartDataObjectPtr.h.

{ return ptr->updateObject(); }

StatusCode SmartDataObjectPtr::update ( IRegistry *  pDirectory )

protected

Update the specified object from the data store.

update the object from the data store.

Parameters

pDirectory

Pointer to the directory entry holding the object.

Returns

StatusCode indicating success or failure.

Definition at line 53 of file SmartDataObjectPtr.cpp.

                                                            {
  return ( m_dataProvider && pRegistry ) ? m_dataProvider->updateObject( pRegistry ) : StatusCode::FAILURE;
}

StatusCode SmartDataObjectPtr::update ( const std::string &  fullPath )

protected

Update the specified object from the data store.

update the object from the data store.

Parameters

fullPath

String containing the full path necessary to locate the object.

Returns

StatusCode indicating success or failure.

Definition at line 58 of file SmartDataObjectPtr.cpp.

                                                                 {
  return ( m_dataProvider ) ? m_dataProvider->updateObject( fullPath ) : StatusCode::FAILURE;
}

DataObject * SmartDataObjectPtr::updateObject

(

)

Object update method.

If the object is not known to the local object, it is requested from the data service either using the full path if there is no directory information present. Needs to be virtual to to implicit object access.

If the object is not known to the local object, it is requested from the data service either using the full path if there is no directory information present.

Definition at line 97 of file SmartDataObjectPtr.cpp.

                                             {
  DataObject* pObj = accessData(); // Have to load AND update if not present.
  if ( m_status.isSuccess() ) {
    m_status = ( !m_pRegistry ? update( m_path ) : update( m_pRegistry ) );
    if ( !m_status.isSuccess() ) pObj = nullptr;
  }
  return pObj;
}

Member Data Documentation

AccessFunction SmartDataObjectPtr::m_accessFunc

protected

Data access function.

Definition at line 168 of file SmartDataObjectPtr.h.

IDataProviderSvc* SmartDataObjectPtr::m_dataProvider = nullptr

mutableprotected

Pointer to contained object.

Definition at line 160 of file SmartDataObjectPtr.h.

std::string SmartDataObjectPtr::m_path

protected

Path to object.

Definition at line 166 of file SmartDataObjectPtr.h.

IRegistry* SmartDataObjectPtr::m_pRegistry = nullptr

mutableprotected

Pointer to the data registry containing the object.

Definition at line 162 of file SmartDataObjectPtr.h.

StatusCode SmartDataObjectPtr::m_status = {StatusCode::SUCCESS, true}

mutableprotected

Keep track of the last error.

Definition at line 164 of file SmartDataObjectPtr.h.

---

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

• GaudiKernel/GaudiKernel/SmartDataObjectPtr.h
• GaudiKernel/src/Lib/SmartDataObjectPtr.cpp