Class holding the configuration for a ICARUS fixture. More...

#include <geometry_unit_test_icarus.h>

Inheritance diagram for icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >:

Public Types
using	base_t = ::testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >

Public Types inherited from testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >
using	ChannelMapClass = CHANNELMAP

Public Member Functions
	IcarusGeometryEnvironmentConfiguration ()
	Default constructor. More...

	IcarusGeometryEnvironmentConfiguration (std::string name)
	Constructor; accepts the name as parameter. More...

Public Member Functions inherited from testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >
	BasicGeometryEnvironmentConfiguration ()
	Default constructor; this is what is used in Boost unit test. More...

	BasicGeometryEnvironmentConfiguration (int argc, char **argv)
	Constructor: acquires parameters from the command line. More...

	BasicGeometryEnvironmentConfiguration (std::string name)
	Constructor; accepts the name as parameter. More...

	BasicGeometryEnvironmentConfiguration (int argc, char **argv, std::string name)

std::string	GeometryParameterSetPath () const

std::string	DefaultGeometryConfiguration () const
	A string describing the default parameter set to configure geometry. More...

void	SetGeometryParameterSetPath (std::string path)
	Sets the FHiCL path for the geometry configuration. More...

void	SetDefaultGeometryConfiguration (std::string cfg)
	Sets a string describing the default parameter set to configure geometry. More...

Public Member Functions inherited from testing::BasicEnvironmentConfiguration
	BasicEnvironmentConfiguration ()
	Default constructor; this is what is used in Boost unit test. More...

	BasicEnvironmentConfiguration (int argc, char **argv)
	Constructor: acquires parameters from the command line. More...

	BasicEnvironmentConfiguration (std::string name)
	Constructor; accepts the name as parameter. More...

	BasicEnvironmentConfiguration (int argc, char **argv, std::string name)

std::string	ApplicationName () const

std::string	ConfigurationPath () const
	Path to the configuration file. More...

std::string	TesterParameterSetPath (std::string name) const
	FHiCL path for the configuration of the test algorithm. More...

std::string	MainTesterParameterSetName () const
	Name of the test algorithm instance. More...

std::string	MainTesterParameterSetPath () const
	FHiCL path for the configuration of the test algorithm. More...

std::string	ServiceParameterSetPath (std::string name) const
	FHiCL path for the configuration of the service. More...

std::string	DefaultTesterConfiguration (std::string tester_name) const
	A string describing default parameter set to configure specified test. More...

std::string	DefaultServiceConfiguration (std::string service_name) const
	A string describing the default parameter set to configure the test. More...

std::string	DefaultConfiguration () const
	A string describing the full default parameter set. More...

std::string	ExecutablePath () const
	Returns the name of the executable as started. More...

std::vector< std::string > const &	EexcutableArguments () const
	Returns the list of non-Boost-test arguments on the command line. More...

void	SetApplicationName (std::string name)
	Sets the name of the application. More...

void	SetConfigurationPath (std::string path)
	Sets the path to the configuration file. More...

void	SetMainTesterParameterSetName (std::string name)
	Sets the FHiCL name for the configuration of the test algorithm. More...

void	SetTesterParameterSetPath (std::string test_name, std::string path)
	Sets the FHiCL path for the configuration of a test algorithm. More...

void	SetMainTesterParameterSetPath (std::string path)
	Sets the FHiCL path for the configuration of the main test algorithm. More...

void	SetServiceParameterSetPath (std::string service_name, std::string path)
	Sets the FHiCL path for the configuration of a test algorithm. More...

void	AddDefaultServiceConfiguration (std::string service_name, std::string service_cfg)
	Adds a default configuration for the specified service. More...

void	AddDefaultTesterConfiguration (std::string tester_name, std::string tester_cfg)
	Adds a default configuration for the specified tester. More...

void	AddDefaultTesterConfiguration (std::string tester_cfg)
	Adds a default configuration for the main tester. More...

Private Member Functions
void	IcarusDefaultInit ()

Additional Inherited Members
Static Public Member Functions inherited from testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >
static std::string	GeometryServiceName ()
	Returns the name of the service. More...

Protected Types inherited from testing::BasicEnvironmentConfiguration
using	ConfigurationMap_t = std::map< std::string, std::string >

using	PathMap_t = std::map< std::string, std::string >

Protected Member Functions inherited from testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >
void	LocalInit ()
	Initialize with some default values. More...

Protected Member Functions inherited from testing::BasicEnvironmentConfiguration
void	ParseCommandLine (int argc, char **argv)
	Extracts arguments from the command line, uses first one as config path. More...

void	DefaultInit ()
	Initialize with some default values. More...

std::string	BuildDefaultServiceConfiguration () const
	A string describing the full default parameter set. More...

std::string	BuildDefaultTestConfiguration () const
	A string describing the full default parameter set. More...

std::string	BuildDefaultConfiguration () const
	A string describing the full default parameter set. More...

Static Protected Member Functions inherited from testing::BasicEnvironmentConfiguration
static std::string	DefaultApplicationName ()
	Returns the default test name. More...

static std::string	BuildServiceConfiguration (ConfigurationMap_t const &services)
	A string with the service section from service parameter sets. More...

static std::string	BuildTestConfiguration (ConfigurationMap_t const &analyzers)
	A string with the physics section from analyzer parameter sets. More...

static std::string	BuildConfiguration (ConfigurationMap_t const &services, ConfigurationMap_t const &modules)
	A string describing the full default parameter set. More...

Protected Attributes inherited from testing::BasicEnvironmentConfiguration
std::string	appl_name
	name of the application More...

std::string	config_path
	configuration file path More...

std::string	main_test_name
	name of main test algorithm More...

std::string	main_test_path
	path of main test algorithm configuration More...

ConfigurationMap_t	services_default_cfg
	Configuration of all the services. More...

ConfigurationMap_t	analyzers_default_cfg
	Configuration of all the analyzer modules. More...

PathMap_t	test_paths
	Set of paths for tester configuration. More...

PathMap_t	service_paths
	Set of paths for service configuration. More...

Detailed Description

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>
struct icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >

Class holding the configuration for a ICARUS fixture.

Template Parameters

CHANNELMAP the class used for channel mapping

See Also: BasicGeometryEnvironmentConfiguration

This class needs to be fully constructed by the default constructor in order to be useful as Boost unit test fixture. It is supposed to be passed as a template parameter to another class that can store an instance of it and extract configuration information from it.

This class should be used with icarus::ICARUSChannelMapAlg.

We reuse BasicGeometryEnvironmentConfiguration as base class and then we fix its setup.

Definition at line 48 of file geometry_unit_test_icarus.h.

Member Typedef Documentation

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>

using icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >::base_t = ::testing::BasicGeometryEnvironmentConfiguration<CHANNELMAP>

Definition at line 53 of file geometry_unit_test_icarus.h.

Constructor & Destructor Documentation

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>

icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >::IcarusGeometryEnvironmentConfiguration ( )

inline

Default constructor.

Definition at line 56 of file geometry_unit_test_icarus.h.

56 { IcarusDefaultInit(); }

icarus::testing::IcarusGeometryEnvironmentConfiguration::IcarusDefaultInit

void IcarusDefaultInit()

Definition: geometry_unit_test_icarus.h:65

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>

icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >::IcarusGeometryEnvironmentConfiguration ( std::string name )

inline

Constructor; accepts the name as parameter.

Definition at line 59 of file geometry_unit_test_icarus.h.

                                                             :
         IcarusGeometryEnvironmentConfiguration()
         { base_t::SetApplicationName(name); }

Member Function Documentation

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>

void icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >::IcarusDefaultInit ( )

inlineprivate

Definition at line 65 of file geometry_unit_test_icarus.h.

         {
           // overwrite the configuration that happened in the base class:
           base_t::SetApplicationName("IcarusGeometryTest");
           base_t::SetDefaultGeometryConfiguration(R"(
            SurfaceY:          130e2 # in cm, vertical distance to the surface
            Name:             "icarus"
            GDML:             "test_27Sep.gdml"
            ROOT:             "test_27Sep.gdml"
            SortingParameters: {}
            )");
         }
 

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

geometry_unit_test_icarus.h

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg> struct icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename CHANNELMAP = icarus::ICARUSChannelMapAlg>
struct icarus::testing::IcarusGeometryEnvironmentConfiguration< CHANNELMAP >