CondCont< T > Class Template Reference

Hold mapping of ranges to condition objects. More...

#include <CondCont.h>

Inheritance diagram for CondCont< T >:

Collaboration diagram for CondCont< T >:

Public Types
typedef CondContBaseInfo< T >::Base	Base
	Base class.
typedef Base::CondContSet	CondContSet
typedef T	Payload
	Payload type held by this class.
typedef CondContBase::key_type	key_type
enum class	KeyType { SINGLE , TIMESTAMP , RUNLBN , MIXED }
	Type of key used for this container. More...

Public Member Functions
	CondCont (Athena::IRCUSvc &rcusvc, const DataObjID &id, SG::DataProxy *proxy=nullptr, size_t capacity=16)
	Constructor.
virtual	~CondCont ()
	Destructor.
	CondCont (const CondCont &)=delete
	No copying.
CondCont &	operator= (const CondCont &)=delete
StatusCode	insert (const EventIDRange &r, std::unique_ptr< T > obj, const EventContext &ctx=Gaudi::Hive::currentContext())
	Insert a new conditions object.
bool	find (const EventIDBase &t, T const *&obj, EventIDRange const **r=nullptr) const
	Look up a conditions object for a given time.
const T *	find (const EventIDBase &t) const
	Look up a conditions object for a given time.
virtual void	list (std::ostream &ost) const override final
	Dump the container contents for debugging.
virtual std::vector< EventIDRange >	ranges () const override final
	Return all IOV validity ranges defined in this container.
virtual StatusCode	typelessInsert (const EventIDRange &r, void *obj, const EventContext &ctx=Gaudi::Hive::currentContext()) override final
	Insert a new conditions object.
virtual bool	valid (const EventIDBase &t) const override final
	Test to see if a given IOV time is mapped in the container.
virtual bool	range (const EventIDBase &t, EventIDRange &r) const override final
	Return the mapped validity range for an IOV time.
virtual StatusCode	erase (const EventIDBase &t, const EventContext &ctx=Gaudi::Hive::currentContext()) override final
	Erase the first element not less than t.
virtual StatusCode	extendLastRange (const EventIDRange &newRange, const EventContext &ctx=Gaudi::Hive::currentContext()) override final
	Extend the range of the last IOV.
CLID	clid () const
	Return the CLID of the most-derived CondCont.
KeyType	keyType () const
	Return the key type for this container.
const DataObjID &	id () const
	Return CLID/key corresponding to this container.
SG::DataProxy *	proxy ()
	Return the associated DataProxy, if any.
const SG::DataProxy *	proxy () const
	Return the associated DataProxy, if any.
void	setProxy (SG::DataProxy *)
	Set the associated DataProxy.
void	print () const
	Dump the container to cout.
virtual size_t	entries () const
	Return the number of conditions objects in the container.
virtual size_t	trim (const std::vector< key_type > &runLbnKeys, const std::vector< key_type > &TSKeys)
	Remove unused entries from the front of the list.
void	clear ()
	Remove all entries in the container.
void	quiescent (const EventContext &ctx=Gaudi::Hive::currentContext())
	Mark that this thread is no longer accessing data from this container.
size_t	nInserts () const
	Return the number times an item was inserted into the map.
size_t	maxSize () const
	Return the maximum size of the map.
void	addDep (CondContBase *dep)
	Declare another conditions container that depends on this one.
std::vector< CondContBase * >	getDeps ()
	Return the list of conditions containers that depend on this one.

Static Public Member Functions
static void	registerBaseInit ()
	Helper to ensure that the inheritance information for this class gets initialized.
static key_type	keyFromRunLBN (const EventIDBase &b)
	Make a run+lbn key from an EventIDBase.
static key_type	keyFromTimestamp (const EventIDBase &b)
	Make a timestamp key from an EventIDBase.
static void setCleanerSvcName	ATLAS_NOT_THREAD_SAFE (const std::string &name)
	Allow overriding the name of the global conditions cleaner service (for testing purposes).

Protected Types
typedef CondContSet::Updater_t	Updater_t
typedef CondContSet::delete_function	delete_function

Protected Member Functions
	CondCont (Athena::IRCUSvc &rcusvc, CLID clid, const DataObjID &id, SG::DataProxy *proxy, std::shared_ptr< typename CondContSet::IPayloadDeleter > payloadDeleter, size_t capacity)
	Internal constructor.
const void *	cast (CLID clid, const void *ptr) const
	Do pointer conversion for the payload type.
virtual const void *	doCast (CLID clid, const void *ptr) const override
	Do pointer conversion for the payload type.
StatusCode	insertBase (const EventIDRange &r, CondContSet::payload_unique_ptr t, const EventContext &ctx=Gaudi::Hive::currentContext())
	Insert a new conditions object.
StatusCode	eraseBase (const EventIDBase &t, const EventContext &ctx=Gaudi::Hive::currentContext())
	Erase the first element not less than t.
StatusCode	extendLastRangeBase (const EventIDRange &newRange, const EventContext &ctx=Gaudi::Hive::currentContext())
	Extend the range of the last IOV.
const void *	findBase (const EventIDBase &t, EventIDRange const **r) const
	Internal lookup function.
template<class FUNC>
void	forEach (const FUNC &func) const
	Call func on each entry in the container.
StatusCode	inserted (const EventContext &ctx)
	Tell the cleaner that a new object was added to the container.
void	insertError (CLID usedCLID) const
	Helper to report an error due to using a base class for insertion.
delete_function *	delfcn () const
	Return the deletion function for this container.
std::string	title () const
	Description of this container to use for MsgStream.

Private Types
using	DepSet = CxxUtils::ConcurrentPtrSet<CondContBase, CxxUtils::SimpleUpdater>
	Other conditions dependencies that depend on this one, as inferred by addDependency calls.

Private Attributes
std::atomic< KeyType >	m_keyType
	Key type of this container.
CLID	m_clid
	CLID of the most-derived CondCont.
DataObjID	m_id
	CLID+key for this container.
SG::DataProxy *	m_proxy
	Associated DataProxy.
CondContSet	m_condSet
	Set of mapped objects.
ServiceHandle< Athena::IConditionsCleanerSvc >	m_cleanerSvc
	Handle to the cleaner service.
DepSet	m_deps

Static Private Attributes
static std::string s_cleanerSvcName	ATLAS_THREAD_SAFE
	Name of the global conditions cleaner service.

Detailed Description

template<typename T>
class CondCont< T >

Hold mapping of ranges to condition objects.

This object holds mappings from a set of IOV ranges (represented as EventIDRange) to conditions objects (which are owned by this object). It has methods to insert a new mapping and to retrieve objects by IOV time.

This object is recorded in the conditions store, so it must have a CLID (the CondCont object, not T). This CLID should be declared using the CONDCONT_DEF macro:

CONDCONT_DEF(TYPE, CLID);

It is possible for one conditions object to derive from another. If TYPE derives from BASE, then declare this with a third argument to CONDCONT_DEF:

CONDCONT_DEF(TYPE, CLID, BASE);

before any references to CondCont<TYPE>. This is implemented by having CondCont<TYPE> derive from CondCont<BASE>. In that case, the mappings will be stored only in the most-derived class.

Definition at line 888 of file CondCont.h.

Member Typedef Documentation

Base

template<typename T>

typedef CondContBaseInfo<T>::Base CondCont< T >::Base

Base class.

Definition at line 892 of file CondCont.h.

CondContSet

template<typename T>

typedef Base::CondContSet CondCont< T >::CondContSet

Definition at line 894 of file CondCont.h.

delete_function

typedef CondContSet::delete_function CondContBase::delete_function

protectedinherited

Definition at line 520 of file CondCont.h.

DepSet

using CondContBase::DepSet = CxxUtils::ConcurrentPtrSet<CondContBase, CxxUtils::SimpleUpdater>

privateinherited

Other conditions dependencies that depend on this one, as inferred by addDependency calls.

There should only be a few of them.

Definition at line 682 of file CondCont.h.

key_type

template<typename T>

typedef CondContBase::key_type CondCont< T >::key_type

Definition at line 899 of file CondCont.h.

Payload

template<typename T>

typedef T CondCont< T >::Payload

Payload type held by this class.

Definition at line 897 of file CondCont.h.

Updater_t

typedef CondContSet::Updater_t CondContBase::Updater_t

protectedinherited

Definition at line 519 of file CondCont.h.

Member Enumeration Documentation

KeyType

enum class CondContBase::KeyType

stronginherited

Type of key used for this container.

Enumerator
SINGLE	Either TIMESTAMP or RUNLBN, but nothing's been put in the container yet, so we don't know which one.
TIMESTAMP	Container uses timestamp keys.
RUNLBN	Container uses run+lbn keys.
MIXED	Mixed Run+lbn / timestamp container.

Definition at line 179 of file CondCont.h.

  {
    SINGLE,

    TIMESTAMP,

    RUNLBN,

    MIXED,
  };

Constructor & Destructor Documentation

CondCont() [1/3]

template<typename T>

CondCont< T >::CondCont	(	Athena::IRCUSvc &	rcusvc,
		const DataObjID &	id,
		SG::DataProxy *	proxy = nullptr,
		size_t	capacity = 16 )

Constructor.

Parameters

rcusvc	RCU service instance.
id	CLID+key for this object.
proxy	DataProxy for this object.
capacity	Initial capacity of the container.

~CondCont()

template<typename T>

virtual CondCont< T >::~CondCont ( )

virtual

Destructor.

CondCont() [2/3]

template<typename T>

CondCont< T >::CondCont ( const CondCont< T > & )

delete

No copying.

CondCont() [3/3]

template<typename T>

CondCont< T >::CondCont ( Athena::IRCUSvc & rcusvc, CLID clid, const DataObjID & id, SG::DataProxy * proxy, std::shared_ptr< typename CondContSet::IPayloadDeleter > payloadDeleter, size_t capacity )

protected

Internal constructor.

Parameters

rcusvc	RCU service instance.
CLID	of the most-derived CondCont.
id	CLID+key for this object.
proxy	DataProxy for this object.
payloadDeleter	Object for deleting payload objects.
capacity	Initial capacity of the container.

Member Function Documentation

addDep()

void CondContBase::addDep ( CondContBase * dep )

inherited

Declare another conditions container that depends on this one.

Parameters

dep	Conditions container that depends on this one.

Definition at line 696 of file CondCont.cxx.

{
  m_deps.insert (dep);
}

ATLAS_NOT_THREAD_SAFE()

void setCleanerSvcName CondContBase::ATLAS_NOT_THREAD_SAFE ( const std::string & name )

staticinherited

Allow overriding the name of the global conditions cleaner service (for testing purposes).

Parameters

name	The name of the global conditions cleaner service.

cast()

template<typename T>

const void * CondCont< T >::cast ( CLID clid, const void * ptr ) const

protected

Do pointer conversion for the payload type.

Parameters

clid	CLID for the desired pointer type.
ptr	Pointer of type T*.

Converts ptr from T* to a pointer to the type given by clid. Returns nullptr if the conversion is not possible.

clear()

void CondContBase::clear ( )

inherited

Remove all entries in the container.

Mostly for testing — should not normally be used.

Definition at line 361 of file CondCont.cxx.

{
  m_condSet.clear();
}

clid()

CLID CondContBase::clid ( ) const

inherited

Return the CLID of the most-derived CondCont.

delfcn()

CondContBase::delete_function * CondContBase::delfcn ( ) const

protectedinherited

Return the deletion function for this container.

Definition at line 740 of file CondCont.cxx.

{
  return m_condSet.deleter().delfcn();
}

doCast()

template<typename T>

virtual const void * CondCont< T >::doCast ( CLID clid, const void * ptr ) const

overrideprotectedvirtual

Do pointer conversion for the payload type.

Parameters

clid	CLID for the desired pointer type.
ptr	Pointer of type T*.

Converts ptr from T* to a pointer to the type given by clid. Returns nullptr if the conversion is not possible.

This is a virtual function that calls cast from the most-derived class of the hierarchy.

Implements CondContBase.

entries()

size_t CondContBase::entries ( ) const

virtualinherited

Return the number of conditions objects in the container.

Reimplemented in CondContMixedBase.

Definition at line 294 of file CondCont.cxx.

{
  return m_condSet.size();
}

erase()

StatusCode CondContSingleBase::erase ( const EventIDBase & t, const EventContext & ctx = Gaudi::Hive::currentContext() )

finaloverridevirtualinherited

Erase the first element not less than t.

Parameters

IOV	time of element to erase.
ctx	Event context for the current thread.

Implements CondContBase.

Definition at line 843 of file CondCont.cxx.

{
  return CondContBase::eraseBase (t, ctx);
}

eraseBase()

StatusCode CondContBase::eraseBase ( const EventIDBase & t, const EventContext & ctx = Gaudi::Hive::currentContext() )

protectedinherited

Erase the first element not less than t.

Parameters

IOV	time of element to erase.
ctx	Event context for the current thread.

Definition at line 539 of file CondCont.cxx.

{
  switch (m_keyType) {
  case KeyType::RUNLBN:
    if (!t.isRunLumi()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::erase: "
          << "Non-Run/LBN key used in Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    m_condSet.erase (CondContBase::keyFromRunLBN (t), ctx);
    break;
  case KeyType::TIMESTAMP:
    if (!t.isTimeStamp()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::erase: "
          << "Non-Timestamp key used in timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    m_condSet.erase (CondContBase::keyFromTimestamp (t), ctx);
    break;
  case KeyType::SINGLE:
    break;
  default:
    std::abort();
  }
  return StatusCode::SUCCESS;
}

extendLastRange()

StatusCode CondContSingleBase::extendLastRange ( const EventIDRange & newRange, const EventContext & ctx = Gaudi::Hive::currentContext() )

finaloverridevirtualinherited

Extend the range of the last IOV.

Parameters

newRange	New validity range.
ctx	Event context.

Returns failure if the start time of newRange does not match the start time of the last IOV in the container. Otherwise, the end time for the last IOV is changed to the end time for newRange. (If the end time for newRange is before the end of the last IOV, then nothing is changed.)

Implements CondContBase.

Definition at line 861 of file CondCont.cxx.

{
  return CondContBase::extendLastRangeBase (newRange, ctx);
}

extendLastRangeBase()

StatusCode CondContBase::extendLastRangeBase ( const EventIDRange & newRange, const EventContext & ctx = Gaudi::Hive::currentContext() )

protectedinherited

Extend the range of the last IOV.

Parameters

newRange	New validity range.
ctx	Event context.

Returns failure if the start time of newRange does not match the start time of the last IOV in the container. Otherwise, the end time for the last IOV is changed to the end time for newRange. (If the end time for newRange is before the end of the last IOV, then nothing is changed.)

Definition at line 583 of file CondCont.cxx.

{
  key_type start;
  key_type stop;
  switch (m_keyType) {
  case KeyType::RUNLBN:
  case KeyType::MIXED:  // To handle the extension case of insertMixed().
    if (!newRange.start().isRunLumi()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::extendLastRange: "
          << "Non-Run/LBN range used in Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    start = keyFromRunLBN (newRange.start());
    stop  = keyFromRunLBN (newRange.stop());
    break;
  case KeyType::TIMESTAMP:
    if (!newRange.start().isTimeStamp()) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::extendLastRange: "
          << "Non-timestamp range used in timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
    start = keyFromTimestamp (newRange.start());
    stop  = keyFromTimestamp (newRange.stop());
    break;
  case KeyType::SINGLE:
    // Empty container.
    return StatusCode::FAILURE;
  default:
    std::abort();
  }
  
  if (m_condSet.extendLastRange (RangeKey (newRange, start, stop), ctx) >= 0)
  {
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

find() [1/2]

template<typename T>

const T * CondCont< T >::find

(

const EventIDBase &

t

)

const

Look up a conditions object for a given time.

Parameters

t	IOV time to find.

Returns the found object, or nullptr.

This variant may be more convenient to call from python.

find() [2/2]

template<typename T>

bool CondCont< T >::find	(	const EventIDBase &	t,
		T const *&	obj,
		EventIDRange const **	r = nullptr ) const

Look up a conditions object for a given time.

Parameters

t	IOV time to find.
obj[out]	Object found.
r	If non-null, copy validity range of the object here.

Returns true if the object was found; false otherwide.

findBase()

const void * CondContBase::findBase ( const EventIDBase & t, EventIDRange const ** r ) const

protectedinherited

Internal lookup function.

Parameters

t	IOV time to find.
r	If non-null, copy validity range of the object here.

Looks up the conditions object corresponding to the IOV time t. If found, return the pointer (as a pointer to the payload type of the most-derived CondCont). Otherwise, return nullptr.

Parameters

clid	CLID for the desired pointer type.
t	IOV time to find.
r	If non-null, copy validity range of the object here.

Looks up the conditions object corresponding to the IOV time t. If found, convert the pointer to a pointer to the type identified by CLID and return it. Otherwise, return nullptr.

Definition at line 637 of file CondCont.cxx.

{
  const void* ptr = nullptr;
  key_type key;
  switch (m_keyType) {
  case KeyType::RUNLBN:
  case KeyType::MIXED:
    if (ATH_UNLIKELY (!t.isRunLumi())) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::findBase: "
          << "Non-Run/LBN key used in Run/LBN container."
          << endmsg;
      return nullptr;
    }
    key = keyFromRunLBN (t);
    break;
  case KeyType::TIMESTAMP:
    if (ATH_UNLIKELY (!t.isTimeStamp())) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::findBase: "
          << "Non-timestamp key used in timestamp container."
          << endmsg;
      return nullptr;
    }
    key = keyFromTimestamp (t);
    break;
  case KeyType::SINGLE:
    // Empty container.
    return nullptr;
  default:
    std::abort();
  }
 
  CondContSet::const_iterator it = m_condSet.find (key);
  if (it && key < it->first.m_stop) {
    if (r) {
      *r = &it->first.m_range;
    }
    ptr = it->second;
  } 
 
  return ptr;
}

forEach()

template<class FUNC>

void CondContBase::forEach ( const FUNC & func ) const

protectedinherited

Call func on each entry in the container.

Parameters

func	Functional to call on each entry.

func will be called on each container element (being passed const CondContSet::value_type&).

getDeps()

std::vector< CondContBase * > CondContBase::getDeps ( )

inherited

Return the list of conditions containers that depend on this one.

Definition at line 705 of file CondCont.cxx.

{
  return std::vector<CondContBase*> (m_deps.begin(), m_deps.end());
}

id()

const DataObjID & CondContBase::id ( ) const

inherited

Return CLID/key corresponding to this container.

insert()

template<typename T>

StatusCode CondCont< T >::insert	(	const EventIDRange &	r,
		std::unique_ptr< T >	obj,
		const EventContext &	ctx = Gaudi::Hive::currentContext() )

Insert a new conditions object.

Parameters

r	Range of validity of this object.
obj	Pointer to the object being inserted.
ctx	Event context for the current thread.

obj must point to an object of type T. This will give an error if this is not called on the most-derived CondCont.

Returns SUCCESS if the object was successfully inserted; EXTENDED if the last existing range in the container was extended to match the new range; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

insertBase()

StatusCode CondContBase::insertBase ( const EventIDRange & r, CondContSet::payload_unique_ptr t, const EventContext & ctx = Gaudi::Hive::currentContext() )

protectedinherited

Insert a new conditions object.

Parameters

r	Range of validity of this object.
t	Pointer to the object being inserted.
ctx	Event context for the current thread.

Returns SUCCESS if the object was successfully inserted; EXTENDED if the last existing range in the container was extended to match the new range; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Definition at line 446 of file CondCont.cxx.

{
  EventIDBase start = r.start();
  EventIDBase stop = r.stop();
 
  key_type start_key, stop_key;
 
  if (m_keyType == KeyType::MIXED) {
    if (start.run_number() == EventIDBase::UNDEFNUM ||
        stop.run_number() == EventIDBase::UNDEFNUM)
    {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Run part of range invalid in mixed container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromRunLBN (start);
    stop_key  = keyFromRunLBN (stop);
  }
  else if (start.isTimeStamp() && stop.isTimeStamp()) {
    if (m_keyType == KeyType::SINGLE) {
      m_keyType = KeyType::TIMESTAMP;
    }
    else if (m_keyType != KeyType::TIMESTAMP) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Timestamp key used in non-timestamp container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromTimestamp (start);
    stop_key  = keyFromTimestamp (stop);
  }
 
  else if (start.run_number() != EventIDBase::UNDEFNUM &&
           stop.run_number() != EventIDBase::UNDEFNUM)
  {
    if (m_keyType == KeyType::SINGLE) {
      m_keyType = KeyType::RUNLBN;
    }
    else if (m_keyType != KeyType::RUNLBN) {
      MsgStream msg (Athena::getMessageSvc(), title());
      msg << MSG::ERROR << "CondContBase::insertBase: "
          << "Run/LBN key used in non-Run/LBN container."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    start_key = keyFromRunLBN (start);
    stop_key  = keyFromRunLBN (stop);
  }
 
  else {
    MsgStream msg (Athena::getMessageSvc(), title());
    msg << MSG::ERROR << "CondContBase::insertBase: EventIDRange " << r 
        << " is neither fully RunEvent nor TimeStamp" 
        << endmsg;
    return StatusCode::FAILURE;
  }
 
  CondContSet::EmplaceResult reslt =
    m_condSet.emplace( RangeKey(r, start_key, stop_key),
                       std::move(t),
                       m_keyType != KeyType::MIXED,
                       ctx );
 
  if (reslt == CondContSet::EmplaceResult::DUPLICATE)
  {
    return CondContStatusCode::DUPLICATE;
  }
  else if (reslt == CondContSet::EmplaceResult::EXTENDED)
  {
    return CondContStatusCode::EXTENDED;
  }
  else if (reslt == CondContSet::EmplaceResult::OVERLAP) {
    return CondContStatusCode::OVERLAP;
  }
 
  return this->inserted (ctx);
}

inserted()

StatusCode CondContBase::inserted ( const EventContext & ctx )

protectedinherited

Tell the cleaner that a new object was added to the container.

Definition at line 686 of file CondCont.cxx.

{
  return m_cleanerSvc->condObjAdded (ctx, *this);
}

insertError()

void CondContBase::insertError ( CLID usedCLID ) const

protectedinherited

Helper to report an error due to using a base class for insertion.

Parameters

usedCLID

CLID of the class used for insertion.

Definition at line 727 of file CondCont.cxx.

{
  MsgStream msg (Athena::getMessageSvc(), title());
  msg << MSG::ERROR << "CondCont<T>::insert: Not most-derived class; "
      << "CLID used: " << usedCLID
      << "; container CLID: " << m_clid
      << endmsg;
}

keyFromRunLBN()

key_type CondContBase::keyFromRunLBN ( const EventIDBase & b )

staticinherited

Make a run+lbn key from an EventIDBase.

Parameters

Event

ID to convert.

keyFromTimestamp()

key_type CondContBase::keyFromTimestamp ( const EventIDBase & b )

staticinherited

Make a timestamp key from an EventIDBase.

Parameters

Event

ID to convert.

keyType()

KeyType CondContBase::keyType ( ) const

inherited

Return the key type for this container.

list()

void CondContSingleBase::list ( std::ostream & ost ) const

finaloverridevirtualinherited

Dump the container contents for debugging.

Parameters

ost	Stream to which to write the dump.

Implements CondContBase.

Definition at line 762 of file CondCont.cxx.

{
  ost << "id: " << id() << "  proxy: " << proxy() << " ["
      << entries() << "] entries" << std::endl;
  forEach ([&] (const CondContSet::value_type& ent)
           { ost << ent.first.m_range << " " << ent.second << std::endl; });
}

maxSize()

size_t CondContBase::maxSize ( ) const

inherited

Return the maximum size of the map.

Definition at line 393 of file CondCont.cxx.

{
  return m_condSet.maxSize();
}

nInserts()

size_t CondContBase::nInserts ( ) const

inherited

Return the number times an item was inserted into the map.

Definition at line 384 of file CondCont.cxx.

{
  return m_condSet.nInserts();
}

operator=()

template<typename T>

CondCont & CondCont< T >::operator= ( const CondCont< T > & )

delete

print()

void CondContBase::print ( ) const

inherited

Dump the container to cout.

For calling from the debugger.

Definition at line 285 of file CondCont.cxx.

{
  list (std::cout);
}

proxy() [1/2]

SG::DataProxy * CondContBase::proxy ( )

inherited

Return the associated DataProxy, if any.

proxy() [2/2]

const SG::DataProxy * CondContBase::proxy ( ) const

inherited

Return the associated DataProxy, if any.

quiescent()

void CondContBase::quiescent ( const EventContext & ctx = Gaudi::Hive::currentContext() )

inherited

Mark that this thread is no longer accessing data from this container.

Parameters

ctx	Event context for the current thread.

This would normally be done through RCU service. Defined here for purposes of testing.

Definition at line 375 of file CondCont.cxx.

{
  m_condSet.quiescent (ctx);
}

range()

bool CondContSingleBase::range ( const EventIDBase & t, EventIDRange & r ) const

finaloverridevirtualinherited

Return the mapped validity range for an IOV time.

Parameters

t	IOV time to check.
r[out]	The range containing t.

Returns true if t is mapped; false otherwise.

Implements CondContBase.

Definition at line 826 of file CondCont.cxx.

{
  const EventIDRange* rp = nullptr;
  if (findBase (t, &rp) != nullptr) {
    r = *rp;
    return true;
  }
  return false;
}

ranges()

std::vector< EventIDRange > CondContSingleBase::ranges ( ) const

finaloverridevirtualinherited

Return all IOV validity ranges defined in this container.

Implements CondContBase.

Definition at line 775 of file CondCont.cxx.

{
  std::vector<EventIDRange> r;
  r.reserve (entries());
 
  forEach ([&] (const CondContSet::value_type& ent)
           { r.push_back (ent.first.m_range); });
 
  return r;
}

registerBaseInit()

template<typename T>

void CondCont< T >::registerBaseInit ( )

static

Helper to ensure that the inheritance information for this class gets initialized.

setProxy()

void CondContBase::setProxy ( SG::DataProxy * proxy )

inherited

Set the associated DataProxy.

Parameters

proxy

The proxy to set.

Definition at line 276 of file CondCont.cxx.

{
  m_proxy = proxy;
}

title()

std::string CondContBase::title ( ) const

protectedinherited

Description of this container to use for MsgStream.

Definition at line 749 of file CondCont.cxx.

{
  return m_id.fullKey();
}

trim()

size_t CondContBase::trim ( const std::vector< key_type > & runLbnKeys, const std::vector< key_type > & TSKeys )

virtualinherited

Remove unused entries from the front of the list.

Parameters

runLbnKeys	List of Run-Lumi keys that may still be in use. (Must be sorted.)
TSKeys	List of time-stamp keys that may still be in use. (Must be sorted.)

We examine the objects in the container, starting with the earliest one. If none of the keys in keys match the range for this object, then it is removed from the container. We stop when we either find an object with a range matching a key in keys or when there is only one object left. Mixed containers are trimmed recursivly.

The list runLbnKeys should contain keys as computed by keyFromRunLBN, the list TSKey should contain keys from keyFromTimestamp. Depending on the type (RUNLUMI, TIMESTAMP, MIXED) only one of the lists or both are used. The list must be sorted.

Removed objects are queued for deletion once all slots have been marked as quiescent.

Returns the number of objects that were removed.

Parameters

keys	List of keys that may still be in use. (Must be sorted.)

We examine the objects in the container, starting with the earliest one. If none of the keys in keys match the range for this object, then it is removed from the container. We stop when we either find an object with a range matching a key in keys or when there is only one object left.

The list keys should contain keys as computed by keyFromRunLBN or keyFromTimestamp, as appropriate for the container's key type (as returned from keyType()). The list must be sorted.

Removed objects are queued for deletion once all slots have been marked as quiescent.

Returns the number of objects that were removed.

Definition at line 320 of file CondCont.cxx.

{
  if (m_keyType == KeyType::RUNLBN) {
      return m_condSet.trim (runLbnKeys);
  }
 
  if (m_keyType == KeyType::TIMESTAMP) {
    return m_condSet.trim ( TSKeys );
  }
 
 
  if (m_keyType == KeyType::MIXED) {
    //For mixed containers, first trim inner container based in TimeStamps
    size_t nTrimmed=0;
    for (const typename CondContSet::value_type& ent : m_condSet.range()) {
      const CondContSet* tsmap = reinterpret_cast<const CondContSet*> (ent.second);
      //size_t before=tsmap->size();
      CondContSet* tsmap_nc ATLAS_THREAD_SAFE = const_cast<CondContSet*>(tsmap);
      // Trim inner containers, allowing the removal of all elements.
      // See ATLASRECTS-7421.
      size_t ntrim=tsmap_nc->trim (TSKeys, true);
      nTrimmed+=ntrim;
      //std::cout << "WL: Trimming inner container for clid " << m_clid << " (" << ntrim << " out of " << before << ", nKeys= " << TSKeys.size() << ")" << std::endl;
    }
    // Then trim outer container based on run-LB.
    size_t outerTrimmed=m_condSet.trim(runLbnKeys);
    //std::cout << "WL: Removing outer sets " << outerTrimmed << ", remaining " << m_condSet.size()  << std::endl; 
    //FIXME: The number returned may be inaccurate, only correct if the outer container
    //has exactly one element left by the time it gets removed.  
    return nTrimmed+outerTrimmed; 
  }
 
//Arrive here for KeyType::SINGLE .. do nothing. 
 return 0;
}

typelessInsert()

StatusCode CondContSingleBase::typelessInsert ( const EventIDRange & r, void * obj, const EventContext & ctx = Gaudi::Hive::currentContext() )

finaloverridevirtualinherited

Insert a new conditions object.

Parameters

r	Range of validity of this object.
obj	Pointer to the object being inserted.
ctx	Event context for the current thread.

obj must point to an object of type T, except in the case of inheritance, where the type of obj must correspond to the most-derived CondCont type. The container will take ownership of this object.

Returns SUCCESS if the object was successfully inserted; EXTENDED if the last existing range in the container was extended to match the new range; OVERLAP if the object was inserted but the range partially overlaps with an existing one; DUPLICATE if the object wasn't inserted because the range duplicates an existing one, and FAILURE otherwise (ownership of the object will be taken in any case).

Implements CondContBase.

Definition at line 808 of file CondCont.cxx.

{
  return insertBase (r,
                     CondContSet::payload_unique_ptr (obj, delfcn()),
                     ctx);
}

valid()

virtual bool CondContSingleBase::valid ( const EventIDBase & t ) const

finaloverridevirtualinherited

Test to see if a given IOV time is mapped in the container.

Parameters

t	IOV time to check.

Implements CondContBase.

Member Data Documentation

ATLAS_THREAD_SAFE

std::string s_cleanerSvcName CondContBase::ATLAS_THREAD_SAFE

staticprivateinherited

Name of the global conditions cleaner service.

Definition at line 686 of file CondCont.h.

m_cleanerSvc

ServiceHandle<Athena::IConditionsCleanerSvc> CondContBase::m_cleanerSvc

privateinherited

Handle to the cleaner service.

Definition at line 678 of file CondCont.h.

m_clid

CLID CondContBase::m_clid

privateinherited

CLID of the most-derived CondCont.

Definition at line 666 of file CondCont.h.

m_condSet

CondContSet CondContBase::m_condSet

privateinherited

Set of mapped objects.

Definition at line 675 of file CondCont.h.

m_deps

DepSet CondContBase::m_deps

privateinherited

Definition at line 683 of file CondCont.h.

m_id

DataObjID CondContBase::m_id

privateinherited

CLID+key for this container.

Definition at line 669 of file CondCont.h.

m_keyType

std::atomic<KeyType> CondContBase::m_keyType

privateinherited

Key type of this container.

Definition at line 663 of file CondCont.h.

m_proxy

SG::DataProxy* CondContBase::m_proxy

privateinherited

Associated DataProxy.

Definition at line 672 of file CondCont.h.

---

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

• CondCont.h