MinimalDataObjectHandle Class Reference

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/MinimalDataObjectHandle.h>

Inheritance diagram for MinimalDataObjectHandle:

Collaboration diagram for MinimalDataObjectHandle:

Public Types
enum	AccessType {   READ, WRITE, UPDATE, READ,   WRITE, UPDATE }
	The type of the access. More...
enum	AccessType {   READ, WRITE, UPDATE, READ,   WRITE, UPDATE }
	The type of the access. More...

Public Member Functions
	MinimalDataObjectHandle ()
	MinimalDataObjectHandle (DataObjectDescriptor &descriptor)
	Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor. More...
virtual	~MinimalDataObjectHandle ()
virtual StatusCode	initialize ()
	Initialize. More...
virtual StatusCode	finalize ()
	Finalize. More...
virtual StatusCode	reinitialize ()
	Reinitialize -> may be overwritten in derived class. More...
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
size_t	dataProductIndex () const
	Return the product index. More...
const std::string &	dataProductName () const
	Return the product name. More...
const std::vector< std::string > &	alternativeDataProductNames () const
StatusCode	setDataProductName (const std::string &address)
	Update address of data product if possible -> not if was written. More...
StatusCode	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
StatusCode	setDataProductNames (const std::vector< std::string > &addresses)
AccessType	accessType () const
	Access type. More...
bool	wasRead () const
	Check if operation was performed. More...
bool	wasWritten () const
	Check if operation was performed. More...
bool	isValid () const
bool	initialized () const
void	lock ()
void	unlock ()
	MinimalDataObjectHandle ()
	MinimalDataObjectHandle (DataObjectDescriptor &descriptor)
	Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor. More...
virtual	~MinimalDataObjectHandle ()
virtual StatusCode	initialize ()
	Initialize. More...
virtual StatusCode	finalize ()
	Finalize. More...
virtual StatusCode	reinitialize ()
	Reinitialize -> may be overwritten in derived class. More...
bool	isOptional () const
	Check if the data object declared is optional for the algorithm. More...
void	setOptional (bool optional=true)
size_t	dataProductIndex () const
	Return the product index. More...
const std::string &	dataProductName () const
	Return the product name. More...
const std::vector< std::string > &	alternativeDataProductNames () const
StatusCode	setDataProductName (const std::string &address)
	Update address of data product if possible -> not if was written. More...
StatusCode	setAlternativeDataProductNames (const std::vector< std::string > &alternativeAddresses)
StatusCode	setDataProductNames (const std::vector< std::string > &addresses)
AccessType	accessType () const
	Access type. More...
bool	wasRead () const
	Check if operation was performed. More...
bool	wasWritten () const
	Check if operation was performed. More...
bool	isValid () const
bool	initialized () const
void	lock ()
void	unlock ()

Protected Member Functions
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
DataObjectDescriptor *	descriptor ()
void	setRead (bool wasRead=true)
void	setWritten (bool wasWritten=true)
DataObjectDescriptor *	descriptor ()

Protected Attributes
DataObjectDescriptor *	m_descriptor

Private Member Functions
size_t	updateDataProductIndex ()
	MinimalDataObjectHandle (const MinimalDataObjectHandle &)
MinimalDataObjectHandle &	operator= (const MinimalDataObjectHandle &)
size_t	updateDataProductIndex ()
	MinimalDataObjectHandle (const MinimalDataObjectHandle &)
MinimalDataObjectHandle &	operator= (const MinimalDataObjectHandle &)

Private Attributes
unsigned int	m_dataProductIndex
bool	m_wasRead
bool	m_wasWritten
bool	m_initialized

Static Private Attributes
static std::unordered_map< std::string, size_t >	m_dataProductIndexMap
static std::map< size_t, std::map< size_t, tbb::spin_mutex > >	m_locks
static const uint	CLEANUP_THRESHOLD = 20

Friends
class	Algorithm
class	AlgTool
class	DataObjectDescriptorCollection

Detailed Description

Definition at line 21 of file MinimalDataObjectHandle.h.

Member Enumeration Documentation

enum MinimalDataObjectHandle::AccessType

The type of the access.

Enumerator
READ	Read only access to the data object.
WRITE	Data object is produced.
UPDATE	Update of data object is allowed.
READ	Read only access to the data object.
WRITE	Data object is produced.
UPDATE	Update of data object is allowed.

Definition at line 26 of file MinimalDataObjectHandle.h.

                  {
    READ,
    WRITE,
    UPDATE
  };

enum MinimalDataObjectHandle::AccessType

The type of the access.

Enumerator
READ	Read only access to the data object.
WRITE	Data object is produced.
UPDATE	Update of data object is allowed.
READ	Read only access to the data object.
WRITE	Data object is produced.
UPDATE	Update of data object is allowed.

Definition at line 26 of file MinimalDataObjectHandle.h.

                  {
    READ,
    WRITE,
    UPDATE
  };

Constructor & Destructor Documentation

MinimalDataObjectHandle::MinimalDataObjectHandle

(

)

Definition at line 7 of file MinimalDataObjectHandle.cpp.

                                                :
  m_descriptor(new DataObjectDescriptor(DataObjectDescriptor::NULL_,
                                        DataObjectDescriptor::NULL_)),

  m_dataProductIndex(-1),
  m_wasRead(false),
  m_wasWritten(false),
  m_initialized(false){
}

MinimalDataObjectHandle::MinimalDataObjectHandle

(

DataObjectDescriptor &

descriptor

)

Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor.

Definition at line 17 of file MinimalDataObjectHandle.cpp.

                                                                                 :
  m_descriptor(&descriptor),
  m_dataProductIndex(updateDataProductIndex()),
  m_wasRead(false),
  m_wasWritten(false),
  m_initialized(false){
}

MinimalDataObjectHandle::~MinimalDataObjectHandle ( )

virtual

Definition at line 25 of file MinimalDataObjectHandle.cpp.

                                                 {
  delete m_descriptor;
}

MinimalDataObjectHandle::MinimalDataObjectHandle ( const MinimalDataObjectHandle &  )

private

MinimalDataObjectHandle::MinimalDataObjectHandle

(

)

MinimalDataObjectHandle::MinimalDataObjectHandle

(

DataObjectDescriptor &

descriptor

)

Constructor initialises the members and registers products in SchedSvc the MinimalDataObjectHandle takes over the ownership of the descriptor.

virtual MinimalDataObjectHandle::~MinimalDataObjectHandle ( )

virtual

MinimalDataObjectHandle::MinimalDataObjectHandle ( const MinimalDataObjectHandle &  )

private

Member Function Documentation

auto MinimalDataObjectHandle::accessType

(

)

const

Access type.

Definition at line 117 of file MinimalDataObjectHandle.cpp.

                                                             {
  return m_descriptor->accessType();
}

AccessType MinimalDataObjectHandle::accessType

(

)

const

Access type.

const std::vector< std::string > & MinimalDataObjectHandle::alternativeDataProductNames

(

)

const

Definition at line 75 of file MinimalDataObjectHandle.cpp.

                                                                                       {
  return m_descriptor->alternativeAddresses();
}

const std::vector<std::string>& MinimalDataObjectHandle::alternativeDataProductNames

(

)

const

size_t MinimalDataObjectHandle::dataProductIndex

(

)

const

Return the product index.

Definition at line 65 of file MinimalDataObjectHandle.cpp.

                                                       {
  return m_dataProductIndex;
}

size_t MinimalDataObjectHandle::dataProductIndex

(

)

const

Return the product index.

const std::string & MinimalDataObjectHandle::dataProductName

(

)

const

Return the product name.

Definition at line 71 of file MinimalDataObjectHandle.cpp.

                                                                {
  return m_descriptor->address();
}

const std::string& MinimalDataObjectHandle::dataProductName

(

)

const

Return the product name.

DataObjectDescriptor * MinimalDataObjectHandle::descriptor ( )

protected

Definition at line 149 of file MinimalDataObjectHandle.cpp.

{return m_descriptor;}

DataObjectDescriptor* MinimalDataObjectHandle::descriptor ( )

protected

virtual StatusCode MinimalDataObjectHandle::finalize ( )

virtual

Finalize.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

StatusCode MinimalDataObjectHandle::finalize ( )

virtual

Finalize.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

Definition at line 49 of file MinimalDataObjectHandle.cpp.

                                            {
  return StatusCode::SUCCESS;
}

StatusCode MinimalDataObjectHandle::initialize ( )

virtual

Initialize.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

Definition at line 31 of file MinimalDataObjectHandle.cpp.

                                              {
  setRead(false);
  setWritten(false);

  m_initialized = true;
  return StatusCode::SUCCESS;
}

virtual StatusCode MinimalDataObjectHandle::initialize ( )

virtual

Initialize.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

bool MinimalDataObjectHandle::initialized ( ) const

inline

Definition at line 86 of file MinimalDataObjectHandle.h.

{ return m_initialized; }

bool MinimalDataObjectHandle::initialized ( ) const

inline

Definition at line 86 of file MinimalDataObjectHandle.h.

{ return m_initialized; }

bool MinimalDataObjectHandle::isOptional

(

)

const

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

Definition at line 55 of file MinimalDataObjectHandle.cpp.

                                               {
  return m_descriptor->optional();
}

bool MinimalDataObjectHandle::isOptional

(

)

const

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

bool MinimalDataObjectHandle::isValid

(

)

const

bool MinimalDataObjectHandle::isValid

(

)

const

Definition at line 129 of file MinimalDataObjectHandle.cpp.

                                            {
  return m_descriptor->valid();
}

void MinimalDataObjectHandle::lock

(

)

Definition at line 178 of file MinimalDataObjectHandle.cpp.

                                  {
  m_locks[Gaudi::Hive::currentContextId()][dataProductIndex()].lock();
}

void MinimalDataObjectHandle::lock

(

)

MinimalDataObjectHandle& MinimalDataObjectHandle::operator= ( const MinimalDataObjectHandle &  )

private

MinimalDataObjectHandle& MinimalDataObjectHandle::operator= ( const MinimalDataObjectHandle &  )

private

StatusCode MinimalDataObjectHandle::reinitialize ( )

virtual

Reinitialize -> may be overwritten in derived class.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

Definition at line 41 of file MinimalDataObjectHandle.cpp.

                                                {
  setRead(false);
  setWritten(false);
  return StatusCode::SUCCESS;
}

virtual StatusCode MinimalDataObjectHandle::reinitialize ( )

virtual

Reinitialize -> may be overwritten in derived class.

Reimplemented in DataObjectHandle< T >, DataObjectHandle< T >, DataObjectHandle< DataObject >, and DataObjectHandle< DataObject >.

StatusCode MinimalDataObjectHandle::setAlternativeDataProductNames

(

const std::vector< std::string > &

alternativeAddresses

)

StatusCode MinimalDataObjectHandle::setAlternativeDataProductNames

(

const std::vector< std::string > &

alternativeAddresses

)

Definition at line 91 of file MinimalDataObjectHandle.cpp.

                                                                                                                   {
  //only allowed if not initialized yet
  if(m_initialized)
    return StatusCode::FAILURE;

  m_descriptor->setAltAddresses(alternativeAddresses);

  updateDataProductIndex();

  return StatusCode::SUCCESS;
}

StatusCode MinimalDataObjectHandle::setDataProductName

(

const std::string &

address

)

Update address of data product if possible -> not if was written.

StatusCode MinimalDataObjectHandle::setDataProductName

(

const std::string &

address

)

Update address of data product if possible -> not if was written.

Definition at line 79 of file MinimalDataObjectHandle.cpp.

                                                                               {
  //only allowed if not initialized yet
  if(m_initialized)
    return StatusCode::FAILURE;

  m_descriptor->setAddress(address);

  updateDataProductIndex();

  return StatusCode::SUCCESS;
}

StatusCode MinimalDataObjectHandle::setDataProductNames

(

const std::vector< std::string > &

addresses

)

Definition at line 103 of file MinimalDataObjectHandle.cpp.

                                                                                             {
  //only allowed if not initialized yet
  if(m_initialized)
    return StatusCode::FAILURE;

  m_descriptor->setAddresses(addresses);

  updateDataProductIndex();

  return StatusCode::SUCCESS;
}

StatusCode MinimalDataObjectHandle::setDataProductNames

(

const std::vector< std::string > &

addresses

)

void MinimalDataObjectHandle::setOptional

(

bool

optional = true

)

Definition at line 59 of file MinimalDataObjectHandle.cpp.

                                                      {
    m_descriptor->setOptional(optional);
}

void MinimalDataObjectHandle::setOptional

(

bool

optional = true

)

void MinimalDataObjectHandle::setRead ( bool  wasRead = true )

protected

Definition at line 141 of file MinimalDataObjectHandle.cpp.

{m_wasRead=wasRead;}

void MinimalDataObjectHandle::setRead ( bool  wasRead = true )

protected

void MinimalDataObjectHandle::setWritten ( bool  wasWritten = true )

protected

Definition at line 145 of file MinimalDataObjectHandle.cpp.

{m_wasWritten=wasWritten;}

void MinimalDataObjectHandle::setWritten ( bool  wasWritten = true )

protected

void MinimalDataObjectHandle::unlock

(

)

Definition at line 182 of file MinimalDataObjectHandle.cpp.

                                    {
  m_locks[Gaudi::Hive::currentContextId()][dataProductIndex()].unlock();

  if(m_locks[Gaudi::Hive::currentContextId()].size() > CLEANUP_THRESHOLD){
    for(auto & lock : m_locks[Gaudi::Hive::currentContextId()]){
      //non-blocking call to try_lock
      //if we can get the lock, then it wasn't set before -- delete it
      if(lock.second.try_lock()){
        m_locks[Gaudi::Hive::currentContextId()].erase(lock.first);
      }
    }

  }
}

void MinimalDataObjectHandle::unlock

(

)

size_t MinimalDataObjectHandle::updateDataProductIndex ( )

private

Definition at line 156 of file MinimalDataObjectHandle.cpp.

                                                       {
  if(dataProductName() == DataObjectDescriptor::NULL_)
    m_dataProductIndex = -1;
  else {
    auto idx = m_dataProductIndexMap.find(dataProductName());
    if(idx != m_dataProductIndexMap.end())
      m_dataProductIndex = idx->second;
    else{
      auto res = m_dataProductIndexMap.emplace(dataProductName(), m_dataProductIndexMap.size());
      m_dataProductIndex = res.first->second;
    }
  }

  return m_dataProductIndex;
}

size_t MinimalDataObjectHandle::updateDataProductIndex ( )

private

bool MinimalDataObjectHandle::wasRead

(

)

const

Check if operation was performed.

Definition at line 123 of file MinimalDataObjectHandle.cpp.

                                            {
  return m_wasRead;
}

bool MinimalDataObjectHandle::wasRead

(

)

const

Check if operation was performed.

bool MinimalDataObjectHandle::wasWritten

(

)

const

Check if operation was performed.

bool MinimalDataObjectHandle::wasWritten

(

)

const

Check if operation was performed.

Definition at line 135 of file MinimalDataObjectHandle.cpp.

                                               {
  return m_wasWritten;
}

Friends And Related Function Documentation

Algorithm

friend

Definition at line 35 of file MinimalDataObjectHandle.h.

AlgTool

friend

Definition at line 36 of file MinimalDataObjectHandle.h.

DataObjectDescriptorCollection

friend

Definition at line 37 of file MinimalDataObjectHandle.h.

Member Data Documentation

static const uint MinimalDataObjectHandle::CLEANUP_THRESHOLD = 20

staticprivate

Definition at line 118 of file MinimalDataObjectHandle.h.

unsigned int MinimalDataObjectHandle::m_dataProductIndex

private

Definition at line 103 of file MinimalDataObjectHandle.h.

static std::unordered_map< std::string, size_t > MinimalDataObjectHandle::m_dataProductIndexMap

staticprivate

Definition at line 111 of file MinimalDataObjectHandle.h.

DataObjectDescriptor * MinimalDataObjectHandle::m_descriptor

protected

Definition at line 92 of file MinimalDataObjectHandle.h.

bool MinimalDataObjectHandle::m_initialized

private

Definition at line 106 of file MinimalDataObjectHandle.h.

static std::map< size_t, std::map< size_t, tbb::spin_mutex > > MinimalDataObjectHandle::m_locks

staticprivate

Definition at line 117 of file MinimalDataObjectHandle.h.

bool MinimalDataObjectHandle::m_wasRead

private

Definition at line 104 of file MinimalDataObjectHandle.h.

bool MinimalDataObjectHandle::m_wasWritten

private

Definition at line 105 of file MinimalDataObjectHandle.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/MinimalDataObjectHandle.h
• GaudiKernel/src/Lib/MinimalDataObjectHandle.cpp