columnar::ColumnarMemoryTest::ColumnarTestToolHandle Class Reference

a handle to a columnar tool for running tests More...

#include <ColumnarMemoryTest.h>

Collaboration diagram for columnar::ColumnarMemoryTest::ColumnarTestToolHandle:

Public Member Functions
	ColumnarTestToolHandle (asg::AsgTool &val_tool)
void	renameContainers (const std::vector< std::pair< std::string, std::string >> &renames)
	rename the columns the tool uses More...
void	initialize ()
	initialize the tool More...
void	applySystematicVariation (const std::string &sysName)
	set the tool to apply the given systematic variation More...
std::vector< ColumnInfo >	getColumnInfo () const
	get the expected column info More...
std::vector< std::string >	getColumnNames () const
	get the expected column names More...
std::vector< std::string >	getRecommendedSystematics () const
	get the recommended systematics More...
const ColumnarToolWrapper &	getToolWrapper () const
	get the tool wrapper More...
IColumnarTool *	getTool ()
	get the contained tool More...

Private Attributes
IColumnarTool *	m_tool = nullptr
CP::ISystematicsTool *	m_systTool = nullptr
std::shared_ptr< const ColumnarToolWrapper >	m_toolWrapper

Detailed Description

a handle to a columnar tool for running tests

This used to be shared with the python bindings, but there are sufficient differences between testing and python bindings to split the two.

Definition at line 46 of file ColumnarMemoryTest.h.

Constructor & Destructor Documentation

ColumnarTestToolHandle()

columnar::ColumnarMemoryTest::ColumnarTestToolHandle::ColumnarTestToolHandle ( asg::AsgTool &  val_tool )

explicit

Public Members

Definition at line 60 of file ColumnarMemoryTest.cxx.

  {
    m_tool = dynamic_cast<IColumnarTool*> (&val_tool);
    if (m_tool == nullptr)
      throw std::runtime_error ("tool does not implement IColumnarTool");
    m_systTool = dynamic_cast<CP::ISystematicsTool*> (m_tool);
  }

Member Function Documentation

applySystematicVariation()

void columnar::ColumnarMemoryTest::ColumnarTestToolHandle::applySystematicVariation

(

const std::string &

sysName

)

set the tool to apply the given systematic variation

Definition at line 91 of file ColumnarMemoryTest.cxx.

  {
    // by convention setting a systematic on a non-systematics tool
    // will do nothing
    if (m_systTool == nullptr)
      return;
    if (!m_systTool->applySystematicVariation (CP::SystematicSet (sysName)).isSuccess())
      throw std::runtime_error ("failed to apply systematic variation");
  }

getColumnInfo()

std::vector< ColumnInfo > columnar::ColumnarMemoryTest::ColumnarTestToolHandle::getColumnInfo

(

)

const

get the expected column info

Definition at line 104 of file ColumnarMemoryTest.cxx.

  {
    if (!m_toolWrapper)
      throw std::runtime_error ("tool not initialized");
    return m_toolWrapper->getColumnInfo ();
  }

getColumnNames()

std::vector< std::string > columnar::ColumnarMemoryTest::ColumnarTestToolHandle::getColumnNames

(

)

const

get the expected column names

Definition at line 114 of file ColumnarMemoryTest.cxx.

  {
    if (!m_toolWrapper)
      throw std::runtime_error ("tool not initialized");
    return m_toolWrapper->getColumnNames ();
  }

getRecommendedSystematics()

std::vector< std::string > columnar::ColumnarMemoryTest::ColumnarTestToolHandle::getRecommendedSystematics

(

)

const

get the recommended systematics

Definition at line 124 of file ColumnarMemoryTest.cxx.

  {
    if (!m_systTool)
      return {""};
    std::vector<std::string> result;
    for (auto& sys : CP::make_systematics_vector (m_systTool->recommendedSystematics()))
      result.push_back (sys.name());
    return result;
  }

getTool()

IColumnarTool * columnar::ColumnarMemoryTest::ColumnarTestToolHandle::getTool

(

)

get the contained tool

Definition at line 147 of file ColumnarMemoryTest.cxx.

  {
    return m_tool;
  }

getToolWrapper()

const ColumnarToolWrapper & columnar::ColumnarMemoryTest::ColumnarTestToolHandle::getToolWrapper

(

)

const

get the tool wrapper

Definition at line 137 of file ColumnarMemoryTest.cxx.

  {
    if (!m_toolWrapper)
      throw std::runtime_error ("tool not initialized");
    return *m_toolWrapper;
  }

initialize()

void columnar::ColumnarMemoryTest::ColumnarTestToolHandle::initialize

(

)

initialize the tool

Definition at line 83 of file ColumnarMemoryTest.cxx.

  {
    m_toolWrapper = std::make_shared<ColumnarToolWrapper> (m_tool);
  }

renameContainers()

void columnar::ColumnarMemoryTest::ColumnarTestToolHandle::renameContainers

(

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

renames

)

rename the columns the tool uses

Definition at line 71 of file ColumnarMemoryTest.cxx.

  {
    columnar::renameContainers (*m_tool, renames);
    if (m_toolWrapper)
    {
      m_toolWrapper = std::make_shared<ColumnarToolWrapper> (m_tool);
    }
  }

Member Data Documentation

m_systTool

CP::ISystematicsTool* columnar::ColumnarMemoryTest::ColumnarTestToolHandle::m_systTool = nullptr

private

Definition at line 87 of file ColumnarMemoryTest.h.

m_tool

IColumnarTool* columnar::ColumnarMemoryTest::ColumnarTestToolHandle::m_tool = nullptr

private

Private Members

Definition at line 86 of file ColumnarMemoryTest.h.

m_toolWrapper

std::shared_ptr<const ColumnarToolWrapper> columnar::ColumnarMemoryTest::ColumnarTestToolHandle::m_toolWrapper

private

Definition at line 89 of file ColumnarMemoryTest.h.

---

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

• ColumnarMemoryTest.h
• ColumnarMemoryTest.cxx