#include <WriteCondHandle.h>

Collaboration diagram for SG::WriteCondHandle< T >:

Public Types
typedef T *	pointer_type
typedef const T *	const_pointer_type
typedef T &	reference_type
typedef const T &	const_reference_type

Public Member Functions
	WriteCondHandle (const WriteCondHandleKey< T > &key)
	WriteCondHandle (const WriteCondHandleKey< T > &key, const EventContext &ctx)
	WriteCondHandle (SG::WriteCondHandleKey< T > &&key)=delete
	WriteCondHandle (SG::WriteCondHandleKey< T > &&key, const EventContext &ctx)=delete
	~WriteCondHandle ()
const std::string &	key () const
const DataObjID &	fullKey () const
bool	isValid () const
bool	isValid (const EventIDBase &t) const
bool	isValid (EventIDRange &range) const
bool	isValid (const EventIDBase &t, EventIDRange &range) const
void	addDependency (const EventIDRange &range)
template<typename R>
void	addDependency (SG::ReadCondHandle< R > &rch)
template<typename R, typename... Args>
void	addDependency (ReadCondHandle< R > &rch, Args... args)
StatusCode	record (const EventIDRange &range, T *t)
	record handle, with explicit range DEPRECATED
StatusCode	record (const EventIDRange &range, std::unique_ptr< T > t)
StatusCode	record (std::unique_ptr< T > t)
	record handle, range must have been set by addDependency(...)
StatusCode	record (T *t)
StatusCode	extendLastRange (const EventIDRange &range, const EventContext &ctx=Gaudi::Hive::currentContext())
	Extend the range of the last IOV.
const std::string &	dbKey () const
const EventIDRange &	getRange () const

Private Attributes
const EventContext &	m_ctx
CondCont< T > *	m_cc {nullptr}
const SG::WriteCondHandleKey< T > &	m_hkey
EventIDRange	m_range {}
bool	m_rangeSet {false}

Detailed Description

template<typename T>
class SG::WriteCondHandle< T >

Definition at line 26 of file WriteCondHandle.h.

Member Typedef Documentation

◆ const_pointer_type

template<typename T>

typedef const T* SG::WriteCondHandle< T >::const_pointer_type

Definition at line 30 of file WriteCondHandle.h.

◆ const_reference_type

template<typename T>

typedef const T& SG::WriteCondHandle< T >::const_reference_type

Definition at line 32 of file WriteCondHandle.h.

◆ pointer_type

template<typename T>

typedef T* SG::WriteCondHandle< T >::pointer_type

Definition at line 29 of file WriteCondHandle.h.

◆ reference_type

template<typename T>

typedef T& SG::WriteCondHandle< T >::reference_type

Definition at line 31 of file WriteCondHandle.h.

Constructor & Destructor Documentation

◆ WriteCondHandle() [1/4]

template<typename T>

SG::WriteCondHandle< T >::WriteCondHandle ( const WriteCondHandleKey< T > & key )

Definition at line 109 of file WriteCondHandle.h.

109 :

110 WriteCondHandle( key, Gaudi::Hive::currentContext() ) {}

SG::WriteCondHandle

Definition WriteCondHandle.h:26

SG::WriteCondHandle::key

const std::string & key() const

Definition WriteCondHandle.h:44

SG::WriteCondHandle::WriteCondHandle

WriteCondHandle(const WriteCondHandleKey< T > &key)

Definition WriteCondHandle.h:109

◆ WriteCondHandle() [2/4]

template<typename T>

SG::WriteCondHandle< T >::WriteCondHandle	(	const WriteCondHandleKey< T > &	key,
		const EventContext &	ctx )

Definition at line 115 of file WriteCondHandle.h.

                                                                :
    m_ctx(ctx),
    m_cc( key.getCC() ),
    m_hkey(key)
  {
    if (m_cc == 0) {
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR 
          << "WriteCondHandle : ptr to CondCont<T> is zero"
          << endmsg;
    }
 
    if (! m_hkey.isInit()) {
      throw SG::ExcUninitKey (key.clid(), key.key(), key.storeHandle().name(),
                              "", "WriteCond");
    }
    
  }

◆ WriteCondHandle() [3/4]

template<typename T>

SG::WriteCondHandle< T >::WriteCondHandle ( SG::WriteCondHandleKey< T > && key )

delete

◆ WriteCondHandle() [4/4]

template<typename T>

SG::WriteCondHandle< T >::WriteCondHandle	(	SG::WriteCondHandleKey< T > &&	key,
		const EventContext &	ctx )

delete

◆ ~WriteCondHandle()

template<typename T>

SG::WriteCondHandle< T >::~WriteCondHandle ( )

inline

Definition at line 42 of file WriteCondHandle.h.

42{};

Member Function Documentation

◆ addDependency() [1/3]

template<typename T>

void SG::WriteCondHandle< T >::addDependency ( const EventIDRange & range )

Definition at line 279 of file WriteCondHandle.h.

                                                                  {
    if ( !m_rangeSet ) {
      m_range = range;
    } else {
      m_range = EventIDRange::intersect(m_range, range);
    }
    m_rangeSet = true;
    using KeyType = CondContBase::KeyType;
    if (m_cc->keyType()==KeyType::RUNLBN && (range.start().isTimeStamp() || range.stop().isTimeStamp())) {
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR << "Adding a time-stamp dependency on a run-lumi indexed CondCont. Consider a mixed ConditionsContainer for type " << fullKey() <<  endmsg;
    }
     if (m_cc->keyType()==KeyType::TIMESTAMP && (range.start().isRunLumi() || range.stop().isRunLumi())) {
       MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
       msg << MSG::ERROR << "Adding a run-lumi dependency on a timestamp-indexed CondCont. Consider a mixed ConditionsContainer for type " << fullKey() <<  endmsg;
    }
  }

◆ addDependency() [2/3]

template<typename T>

template<typename R, typename... Args>

void SG::WriteCondHandle< T >::addDependency	(	ReadCondHandle< R > &	rch,
		Args...	args )

Definition at line 310 of file WriteCondHandle.h.

                                                                        {
     addDependency( rch );
     return addDependency( args... );
  }

◆ addDependency() [3/3]

template<typename T>

template<typename R>

void SG::WriteCondHandle< T >::addDependency ( SG::ReadCondHandle< R > & rch )

Definition at line 301 of file WriteCondHandle.h.

                                                            {
    CondContBase* dep_cc = rch.getCC();
    dep_cc->addDep (m_cc);
    return addDependency(rch.getRange());
  }

◆ dbKey()

template<typename T>

const std::string & SG::WriteCondHandle< T >::dbKey ( ) const

inline

Definition at line 91 of file WriteCondHandle.h.

91{ return m_hkey.dbKey(); }

◆ extendLastRange()

template<typename T>

StatusCode SG::WriteCondHandle< T >::extendLastRange	(	const EventIDRange &	r,
		const EventContext &	ctx = Gaudi::Hive::currentContext() )

Extend the range of the last IOV.

Parameters

range	New validity range.
ctx	Event context.

Returns failure if the start time of range 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 range. (If the end time for range is before the end of the last IOV, then nothing is changed.)

Definition at line 232 of file WriteCondHandle.h.

  {
    return m_cc->extendLastRange (r, ctx);
  }

◆ fullKey()

template<typename T>

const DataObjID & SG::WriteCondHandle< T >::fullKey ( ) const

inline

Definition at line 45 of file WriteCondHandle.h.

45{ return m_hkey.fullKey(); }

◆ getRange()

template<typename T>

const EventIDRange & SG::WriteCondHandle< T >::getRange ( ) const

inline

Definition at line 93 of file WriteCondHandle.h.

93{ return m_range; }

◆ isValid() [1/4]

template<typename T>

bool SG::WriteCondHandle< T >::isValid ( ) const

Definition at line 252 of file WriteCondHandle.h.

                                    {
 
    return (m_cc->valid(m_ctx.eventID()));
  }

◆ isValid() [2/4]

template<typename T>

bool SG::WriteCondHandle< T >::isValid ( const EventIDBase & t ) const

Definition at line 242 of file WriteCondHandle.h.

                                                        {
 
    return (m_cc->valid(t));
  }

◆ isValid() [3/4]

template<typename T>

bool SG::WriteCondHandle< T >::isValid	(	const EventIDBase &	t,
		EventIDRange &	range ) const

Definition at line 261 of file WriteCondHandle.h.

                                                                             {
 
    return (m_cc->range(t, range));
  }

◆ isValid() [4/4]

template<typename T>

bool SG::WriteCondHandle< T >::isValid ( EventIDRange & range ) const

Definition at line 271 of file WriteCondHandle.h.

                                                        {
 
    return (m_cc->range(m_ctx.eventID(), range));
  }

◆ key()

template<typename T>

const std::string & SG::WriteCondHandle< T >::key ( ) const

inline

Definition at line 44 of file WriteCondHandle.h.

44{ return m_hkey.key(); }

◆ record() [1/4]

template<typename T>

StatusCode SG::WriteCondHandle< T >::record	(	const EventIDRange &	range,
		std::unique_ptr< T >	t )

Definition at line 140 of file WriteCondHandle.h.

  {
    
    if (m_rangeSet) {
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR
          << "WriteCondHandle::record(EventIDRange, T*): for key "
          << this->fullKey()
          << " cannot use this method if range has already been set via dependencies"
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    m_range = r;
    m_rangeSet = true;
 
    return record( std::move(t) );
  }

◆ record() [2/4]

template<typename T>

StatusCode SG::WriteCondHandle< T >::record	(	const EventIDRange &	range,
		T *	t )

record handle, with explicit range DEPRECATED

Parameters

range	IOVRange of handle
t	unique_ptr to handle

Definition at line 161 of file WriteCondHandle.h.

  {
    return record (r, std::unique_ptr<T> (t));
  }

◆ record() [3/4]

template<typename T>

StatusCode SG::WriteCondHandle< T >::record ( std::unique_ptr< T > t )

record handle, range must have been set by addDependency(...)

Parameters

t	unique_ptr to handle

Definition at line 174 of file WriteCondHandle.h.

                                               {
    if (! m_rangeSet) {
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR 
          << "WriteCondHandle::record() : no range defined for key "
          << this->fullKey()
          << endmsg;
      return StatusCode::FAILURE;
    }
 
    #ifndef NDEBUG
    MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
    if (msg.level() <= MSG::DEBUG) {
      msg << MSG::DEBUG
          << "WriteCondHandle::record() : obj at: " << t.get() << "  range: "
          << m_range << endmsg;
    }
    #endif
 
    StatusCode sc = m_cc->insert(m_range, std::move(t));
    // Preserve sc for return, since it may be DUPLICATE.
    if (sc.isFailure()) {
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR 
          << "WriteCondHandle::record() : unable to insert obj in CondCont<T>"
          << endmsg;
      return StatusCode::FAILURE;
    } else if (CondContBase::Category::isOverlap (sc)) {
#if 0
      // Temporarily disable this check until caching issues with IOVDbSvc
      // are sorted out.
      MsgStream msg(Athena::getMessageSvc(), "WriteCondHandle");
      msg << MSG::ERROR 
          << "WriteCondHandle::record() : IOV ranges overlap."
          << endmsg;
      return StatusCode::FAILURE;
#endif
      sc = StatusCode::SUCCESS;
    }
 
    return sc;
  }

◆ record() [4/4]

template<typename T>

StatusCode SG::WriteCondHandle< T >::record ( T * t )

Definition at line 168 of file WriteCondHandle.h.

                                 {
    return record (std::unique_ptr<T> (t));    
  }

Member Data Documentation

◆ m_cc

template<typename T>

CondCont<T>* SG::WriteCondHandle< T >::m_cc {nullptr}

private

Definition at line 98 of file WriteCondHandle.h.

98{nullptr};

◆ m_ctx

template<typename T>

const EventContext& SG::WriteCondHandle< T >::m_ctx

private

Definition at line 97 of file WriteCondHandle.h.

◆ m_hkey

template<typename T>

const SG::WriteCondHandleKey<T>& SG::WriteCondHandle< T >::m_hkey

private

Definition at line 100 of file WriteCondHandle.h.

◆ m_range

template<typename T>

EventIDRange SG::WriteCondHandle< T >::m_range {}

private

Definition at line 102 of file WriteCondHandle.h.

102{};

◆ m_rangeSet

template<typename T>

bool SG::WriteCondHandle< T >::m_rangeSet {false}

private

Definition at line 103 of file WriteCondHandle.h.

103{false};

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

WriteCondHandle.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_pointer_type

◆ const_reference_type

◆ pointer_type

◆ reference_type

Constructor & Destructor Documentation

◆ WriteCondHandle() [1/4]

◆ WriteCondHandle() [2/4]

◆ WriteCondHandle() [3/4]

◆ WriteCondHandle() [4/4]

◆ ~WriteCondHandle()

Member Function Documentation

◆ addDependency() [1/3]

◆ addDependency() [2/3]

◆ addDependency() [3/3]

◆ dbKey()

◆ extendLastRange()

◆ fullKey()

◆ getRange()

◆ isValid() [1/4]

◆ isValid() [2/4]

◆ isValid() [3/4]

◆ isValid() [4/4]

◆ key()

◆ record() [1/4]

◆ record() [2/4]

◆ record() [3/4]

◆ record() [4/4]

Member Data Documentation

◆ m_cc

◆ m_ctx

◆ m_hkey

◆ m_range

◆ m_rangeSet