DataObjectHandleBase Class Reference

DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h. More...

#include <GaudiKernel/DataObjectHandleBase.h>

Inheritance diagram for DataObjectHandleBase:

Collaboration diagram for DataObjectHandleBase:

Public Member Functions
	DataObjectHandleBase ()
	DataObjectHandleBase (const DataObjID &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
	DataObjectHandleBase (const std::string &k, Gaudi::DataHandle::Mode a, IDataHandleHolder *o)
virtual	~DataObjectHandleBase ()
const std::string	toString () const
const std::string	pythonRepr () const override
void	fromString (const std::string &s)
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
const std::vector< std::string > &	alternativeDataProductNames () const
void	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
bool	initialized () const
bool	wasRead () const
bool	wasWritten () const
bool	isValid () const
Public Member Functions inherited from Gaudi::DataHandle
	DataHandle ()
	DataHandle (const DataObjID &k, Mode a=Reader, IDataHandleHolder *owner=0)
virtual	~DataHandle ()
virtual void	setOwner (IDataHandleHolder *o)
virtual IDataHandleHolder *	owner () const
virtual Mode	mode () const
virtual void	setKey (const DataObjID &key)
virtual void	updateKey (const std::string &key)
virtual const std::string &	objKey () const
virtual const DataObjID &	fullKey () const
virtual void	reset (bool)
virtual StatusCode	commit ()

Protected Member Functions
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
void	init ()
Protected Member Functions inherited from Gaudi::DataHandle
virtual void	setMode (const Mode &mode)

Protected Attributes
SmartIF< IDataProviderSvc >	m_EDS
SmartIF< IMessageSvc >	m_MS
bool	m_init
bool	m_goodType
bool	m_optional
bool	m_wasRead
bool	m_wasWritten
std::vector< std::string >	m_altNames
Protected Attributes inherited from Gaudi::DataHandle
DataObjID	m_key
IDataHandleHolder *	m_owner

Friends
std::ostream &	operator<< (std::ostream &str, const DataObjectHandleBase &d)

Additional Inherited Members
Public Types inherited from Gaudi::DataHandle
enum	Mode { Reader = 1<<2, Writer = 1<<4, Updater = Reader | Writer }

Detailed Description

DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h.

Base class for handles to Data Objects in the Event Store, to simplify access via Properties.

provides accessors to AlternateNames, and Optional parameters

Author

Charles Leggett

Date

2015-09-01

Definition at line 24 of file DataObjectHandleBase.h.

Constructor & Destructor Documentation

DataObjectHandleBase::DataObjectHandleBase

(

)

Definition at line 15 of file DataObjectHandleBase.cpp.

                                          :
  Gaudi::DataHandle(), m_init(false), 
  m_goodType(false), m_optional(false), m_wasRead(false), m_wasWritten(false) {}

DataObjectHandleBase::DataObjectHandleBase	(	const DataObjID &	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	o
	)

Definition at line 20 of file DataObjectHandleBase.cpp.

                                               :
  Gaudi::DataHandle(k,a,owner), m_init(false), m_goodType(false),
  m_optional(false), m_wasRead(false), m_wasWritten(false) {}

DataObjectHandleBase::DataObjectHandleBase	(	const std::string &	k,
		Gaudi::DataHandle::Mode	a,
		IDataHandleHolder *	o
	)

Definition at line 28 of file DataObjectHandleBase.cpp.

                                               :
  DataObjectHandleBase(DataObjID(k), a, owner){}

virtual DataObjectHandleBase::~DataObjectHandleBase ( )

inlinevirtual

Definition at line 34 of file DataObjectHandleBase.h.

{}

Member Function Documentation

const std::vector<std::string>& DataObjectHandleBase::alternativeDataProductNames ( ) const

inline

Definition at line 48 of file DataObjectHandleBase.h.

                                                                   {
    return m_altNames; }

void DataObjectHandleBase::fromString

(

const std::string &

s

)

Definition at line 54 of file DataObjectHandleBase.cpp.

                                                   {
  Gaudi::Parsers::parse(*this,s).ignore();
}

void DataObjectHandleBase::init ( )

protected

Definition at line 61 of file DataObjectHandleBase.cpp.

                           {

  if (m_init) return;

  if (m_owner == 0) return;

  setRead(false);
  setWritten(false);

  Algorithm* algorithm = dynamic_cast<Algorithm*>( m_owner );
  if (algorithm != 0) {
    // Fetch the event Data Service from the algorithm
    m_EDS = algorithm->evtSvc();
    m_MS = algorithm->msgSvc();
  } else {
    AlgTool* tool = dynamic_cast<AlgTool*>( owner() );
    if (tool != 0) {
      m_EDS = tool->evtSvc();
      m_MS = tool->msgSvc();
    } else {
      throw GaudiException( "owner is not an AlgTool or Algorithm" ,
                "Invalid Cast", StatusCode::FAILURE) ;
    }
  }
  
  m_init = true;

}

bool DataObjectHandleBase::initialized ( ) const

inline

Definition at line 52 of file DataObjectHandleBase.h.

{ return m_init; }

bool DataObjectHandleBase::isOptional ( ) const

inline

Check if the data object declared is optional for the algorithm.

Definition at line 45 of file DataObjectHandleBase.h.

{return m_optional;}

bool DataObjectHandleBase::isValid

(

)

const

Definition at line 93 of file DataObjectHandleBase.cpp.

                                    {

  return  ( fullKey() != INVALID_DATAOBJID );

}

const std::string DataObjectHandleBase::pythonRepr ( ) const

overridevirtual

Reimplemented from Gaudi::DataHandle.

Definition at line 48 of file DataObjectHandleBase.cpp.

                                       {
  return "DataObjectHandleBase(\"" + toString() + "\")";
}

void DataObjectHandleBase::setAlternativeDataProductNames ( const std::vector< std::string > &  alternativeAddresses )

inline

Definition at line 50 of file DataObjectHandleBase.h.

{ m_altNames = alternativeAddresses; }

void DataObjectHandleBase::setOptional ( bool  optional = true )

inline

Definition at line 46 of file DataObjectHandleBase.h.

{ m_optional = optional; }

void DataObjectHandleBase::setRead ( bool  wasRead = true )

inlineprotected

Definition at line 59 of file DataObjectHandleBase.h.

{m_wasRead = wasRead;}

void DataObjectHandleBase::setWritten ( bool  wasWritten = true )

inlineprotected

Definition at line 60 of file DataObjectHandleBase.h.

{m_wasWritten = wasWritten;}

const std::string DataObjectHandleBase::toString

(

)

const

Definition at line 36 of file DataObjectHandleBase.cpp.

                                     {
  std::ostringstream ost;
  ost << m_key << "|" << mode() << "|" << isOptional() << "|";
  for (auto &a : m_altNames) {
    ost << a << "&";
  }
  //  ost << ")";
  return ost.str();
}

bool DataObjectHandleBase::wasRead ( ) const

inline

Definition at line 53 of file DataObjectHandleBase.h.

{ return m_wasRead; }

bool DataObjectHandleBase::wasWritten ( ) const

inline

Definition at line 54 of file DataObjectHandleBase.h.

{ return m_wasWritten; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  str, const DataObjectHandleBase &  d  )

friend

Definition at line 102 of file DataObjectHandleBase.cpp.

                                                            {

  str << d.fullKey() << "  m: " << d.mode();
  if (d.owner() != 0) {
    str << "  o: " << d.owner()->name();
  }

  str << "  opt: " << d.isOptional();

  if (d.alternativeDataProductNames().size() != 0) {
    str << "  alt: [";
    for ( auto &n : d.alternativeDataProductNames()) {
      str << n << ",";
    }
    str << "]";
  }

  return str;
}

Member Data Documentation

std::vector<std::string> DataObjectHandleBase::m_altNames

protected

Definition at line 74 of file DataObjectHandleBase.h.

SmartIF<IDataProviderSvc> DataObjectHandleBase::m_EDS

protected

Definition at line 66 of file DataObjectHandleBase.h.

bool DataObjectHandleBase::m_goodType

protected

Definition at line 70 of file DataObjectHandleBase.h.

bool DataObjectHandleBase::m_init

protected

Definition at line 69 of file DataObjectHandleBase.h.

SmartIF<IMessageSvc> DataObjectHandleBase::m_MS

protected

Definition at line 67 of file DataObjectHandleBase.h.

bool DataObjectHandleBase::m_optional

protected

Definition at line 71 of file DataObjectHandleBase.h.

bool DataObjectHandleBase::m_wasRead

protected

Definition at line 72 of file DataObjectHandleBase.h.

bool DataObjectHandleBase::m_wasWritten

protected

Definition at line 72 of file DataObjectHandleBase.h.

---

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

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