CaloUtils::ToolWithConstantsImpl Class Reference

Internal implementation object. More...

#include <ToolWithConstants.h>

Collaboration diagram for CaloUtils::ToolWithConstantsImpl:

Public Types
using	Context = ToolConstantsContext

Public Member Functions
	ToolWithConstantsImpl (const std::string &toolName, const std::string &prefix, SG::ReadCondHandleKey< CaloRec::ToolConstants > &DBHandle)
	Constructor. More...
StatusCode	initialize ()
	Initialize. More...
Context	context (const EventContext &ctx) const
	Create a Context object. More...
void	addConstant (IToolConstant *c)
	Add a new constant to the tool. More...
void	writeConstants (std::ostream &stream, const std::string &name, const EventContext &ctx) const
	Dump method (for debugging) More...
StatusCode	mergeConstants (const std::string &typeName, int toolVersion, Context &myctx, bool isDummy, CaloRec::ToolConstants &out) const
	Merge our constants into out with the proper prefix. More...

Public Attributes
std::string	m_toolName
	Name of the owning tool. More...
const std::string &	m_prefix
	The prefix of this constant in COOL. More...
CaloRec::ToolConstants	m_constants
	For settings made from JO. More...
SG::ReadCondHandleKey< CaloRec::ToolConstants > &	m_DBHandle
	Handle to a ToolConstants conditions object. More...
std::vector< IToolConstant * >	m_declaredConstants
	All constants declared to this tool. More...

Detailed Description

Internal implementation object.

Allows factoring out code which doesn't depend on template parameters.

Definition at line 102 of file ToolWithConstants.h.

Member Typedef Documentation

Context

using CaloUtils::ToolWithConstantsImpl::Context = ToolConstantsContext

Definition at line 105 of file ToolWithConstants.h.

Constructor & Destructor Documentation

ToolWithConstantsImpl()

CaloUtils::ToolWithConstantsImpl::ToolWithConstantsImpl	(	const std::string &	toolName,
		const std::string &	prefix,
		SG::ReadCondHandleKey< CaloRec::ToolConstants > &	DBHandle
	)

Constructor.

Parameters

toolName	Name of the tool.
prefix	Constant prefix in COOL.
DBHandle	Handle key for the conditions object.

Definition at line 24 of file ToolWithConstants.cxx.

  : m_toolName (toolName),
    m_prefix (prefix),
    m_DBHandle (DBHandle)
{
}

Member Function Documentation

addConstant()

void CaloUtils::ToolWithConstantsImpl::addConstant

(

IToolConstant *

c

)

Add a new constant to the tool.

Parameters

c	Constant to add.

Definition at line 66 of file ToolWithConstants.cxx.

{
  m_declaredConstants.push_back (c);
}

context()

ToolWithConstantsImpl::Context CaloUtils::ToolWithConstantsImpl::context

(

const EventContext &

ctx

)

const

Create a Context object.

This can then be passed to Constant::operator().

Definition at line 51 of file ToolWithConstants.cxx.

{
  const CaloRec::ToolConstants* constants = nullptr;
  if (!m_DBHandle.empty()) {
    SG::ReadCondHandle<CaloRec::ToolConstants> consts (m_DBHandle, ctx);
    constants = consts.retrieve();
  }
  return Context (constants, ctx);
}

initialize()

StatusCode CaloUtils::ToolWithConstantsImpl::initialize

(

)

Initialize.

Definition at line 38 of file ToolWithConstants.cxx.

{
  ATH_CHECK( m_DBHandle.initialize (SG::AllowEmpty) );
  return StatusCode::SUCCESS;
}

mergeConstants()

StatusCode CaloUtils::ToolWithConstantsImpl::mergeConstants	(	const std::string &	typeName,
		int	toolVersion,
		Context &	myctx,
		bool	isDummy,
		CaloRec::ToolConstants &	out
	)		const

Merge our constants into out with the proper prefix.

Parameters

	typeName	Name of the type of the tool.
	toolVersion	Version of the tool.
	myctx	Internal Context structure.
	isDummy	isDummy constant from the tool
[out]	out	Object to receive our constants.

Definition at line 101 of file ToolWithConstants.cxx.

{
  if (out.clsname().empty()) {
    out.clsname (typeName);
    out.version (toolVersion);
  }
  else if (out.clsname() != typeName) {
    REPORT_ERROR_WITH_CONTEXT(StatusCode::FAILURE, m_toolName)
      << "Trying to write to ToolConstants for tools of differing types: "
      << out.clsname() << " and " << typeName;
    return StatusCode::FAILURE;
  }
  else if (out.version() != toolVersion) {
    REPORT_ERROR_WITH_CONTEXT(StatusCode::FAILURE, m_toolName)
      << "Trying to write to ToolConstants for differing versions of tool "
      << out.clsname() << ": " << out.version() << " and " << toolVersion;
    return StatusCode::FAILURE;
  }
 
  for (IToolConstant* c : m_declaredConstants) {
    std::string cname = c->name();
    std::string prefname = this->m_prefix + cname;
    const CaloRec::Arrayrep* rep = nullptr;
    if (m_constants.hasrep (cname)) {
      rep = &m_constants.getrep (m_toolName, cname);
    }
    if (!c->setFromJO() &&
        myctx.m_constants &&
        myctx.m_constants->hasrep (prefname))
    {
      rep = &myctx.m_constants->getrep (m_toolName, prefname);
    }
    if (!rep) {
      throw ExcConstantNotSet (m_toolName, cname);
    }
 
    if (!isDummy || cname == "isDummy")
      out.setrep (this->m_prefix + cname, *rep);
  }
  return StatusCode::SUCCESS;
}

writeConstants()

void CaloUtils::ToolWithConstantsImpl::writeConstants	(	std::ostream &	stream,
		const std::string &	name,
		const EventContext &	ctx
	)		const

Dump method (for debugging)

Parameters

stream	Ostream to which to write.
name	Name to go in output
ctx	Event context.

Definition at line 78 of file ToolWithConstants.cxx.

{
  stream << "Member: m_constants" << std::endl;
  m_constants.writeConstants (stream,name);
  if (!m_DBHandle.empty()) {
    SG::ReadCondHandle<CaloRec::ToolConstants> consts (m_DBHandle, ctx);
    stream << "Member: m_DBconstants" << std::endl;
    consts->writeConstants (stream,name);
  }
}

Member Data Documentation

m_constants

CaloRec::ToolConstants CaloUtils::ToolWithConstantsImpl::m_constants

For settings made from JO.

Definition at line 177 of file ToolWithConstants.h.

m_DBHandle

SG::ReadCondHandleKey<CaloRec::ToolConstants>& CaloUtils::ToolWithConstantsImpl::m_DBHandle

Handle to a ToolConstants conditions object.

Definition at line 180 of file ToolWithConstants.h.

m_declaredConstants

std::vector<IToolConstant*> CaloUtils::ToolWithConstantsImpl::m_declaredConstants

All constants declared to this tool.

Definition at line 183 of file ToolWithConstants.h.

m_prefix

const std::string& CaloUtils::ToolWithConstantsImpl::m_prefix

The prefix of this constant in COOL.

Definition at line 174 of file ToolWithConstants.h.

m_toolName

std::string CaloUtils::ToolWithConstantsImpl::m_toolName

Name of the owning tool.

Definition at line 168 of file ToolWithConstants.h.

---

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

• ToolWithConstants.h
• ToolWithConstants.cxx