testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP > Struct Template Reference

Class holding a configuration for a test environment. More...

#include "geometry_unit_test_base.h"

Inheritance diagram for testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >:

Public Types
using	ChannelMapClass = CHANNELMAP

Public Member Functions
	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)
Access to configuration
FHiCL path for the geometry configuration
std::string	GeometryParameterSetPath () const
	A string describing the default parameter set to configure geometry. More...
std::string	DefaultGeometryConfiguration () const
	A string describing the default parameter set to configure geometry. More...
Set configuration
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...
Access to configuration
Name of the application
std::string	ApplicationName () const
	Path to the configuration file. More...
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...
Set configuration
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...

Static Public Member Functions
static std::string	GeometryServiceName ()
	Returns the name of the service. More...

Protected Types
using	ConfigurationMap_t = std::map< std::string, std::string >
using	PathMap_t = std::map< std::string, std::string >

Protected Member Functions
void	LocalInit ()
	Initialize with some default values. More...
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
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
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>
struct testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >

Class holding a configuration for a test environment.

---

Template Parameters

CHANNELMAP

the class used for channel mapping

See also

GeometryTesterEnvironment

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.

Definition at line 67 of file geometry_unit_test_base.h.

Member Typedef Documentation

template<typename CHANNELMAP >

using testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::ChannelMapClass = CHANNELMAP

Definition at line 68 of file geometry_unit_test_base.h.

using testing::BasicEnvironmentConfiguration::ConfigurationMap_t = std::map<std::string, std::string>

protectedinherited

Definition at line 262 of file unit_test_base.h.

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

protectedinherited

Definition at line 263 of file unit_test_base.h.

Constructor & Destructor Documentation

template<typename CHANNELMAP >

testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::BasicGeometryEnvironmentConfiguration ( )

inline

Default constructor; this is what is used in Boost unit test.

Definition at line 71 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit().

: BasicEnvironmentConfiguration() { LocalInit(); }

template<typename CHANNELMAP >

testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::BasicGeometryEnvironmentConfiguration ( int  argc, char **  argv  )

inline

Constructor: acquires parameters from the command line.

Definition at line 74 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit().

      : BasicEnvironmentConfiguration(argc, argv)
    {
      LocalInit();
    }

template<typename CHANNELMAP >

testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::BasicGeometryEnvironmentConfiguration ( std::string  name )

inline

Constructor; accepts the name as parameter.

Definition at line 81 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit().

                                                          : BasicEnvironmentConfiguration(name)
    {
      LocalInit();
    }

template<typename CHANNELMAP >

testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::BasicGeometryEnvironmentConfiguration ( int  argc, char **  argv, std::string  name  )

inline

Definition at line 86 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit().

      : BasicEnvironmentConfiguration(argc, argv, name)
    {
      LocalInit();
    }

Member Function Documentation

void testing::BasicEnvironmentConfiguration::AddDefaultServiceConfiguration ( std::string  service_name, std::string  service_cfg  )

inlineinherited

Adds a default configuration for the specified service.

Definition at line 239 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetDefaultGeometryConfiguration().

    {
      services_default_cfg[service_name] = service_cfg;
    }

void testing::BasicEnvironmentConfiguration::AddDefaultTesterConfiguration ( std::string  tester_name, std::string  tester_cfg  )

inlineinherited

Adds a default configuration for the specified tester.

Definition at line 245 of file unit_test_base.h.

    {
      analyzers_default_cfg[tester_name] = tester_cfg;
    }

void testing::BasicEnvironmentConfiguration::AddDefaultTesterConfiguration ( std::string  tester_cfg )

inlineinherited

Adds a default configuration for the main tester.

Definition at line 251 of file unit_test_base.h.

References util::empty().

    {
      if (MainTesterParameterSetName().empty()) {
        throw std::logic_error("Request adding configuration of non-existent main tester");
      }
      AddDefaultTesterConfiguration(MainTesterParameterSetName(), tester_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::ApplicationName ( ) const

inlineinherited

Path to the configuration file.

Definition at line 152 of file unit_test_base.h.

{ return appl_name; }

static std::string testing::BasicEnvironmentConfiguration::BuildConfiguration ( ConfigurationMap_t const &  services, ConfigurationMap_t const &  modules  )

inlinestaticprotectedinherited

A string describing the full default parameter set.

Definition at line 364 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += BuildServiceConfiguration(services);
      cfg += BuildTestConfiguration(modules);
      return cfg;
    } // BuildConfiguration()

std::string testing::BasicEnvironmentConfiguration::BuildDefaultConfiguration ( ) const

inlineprotectedinherited

A string describing the full default parameter set.

Definition at line 327 of file unit_test_base.h.

    {
      return BuildConfiguration(services_default_cfg, analyzers_default_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::BuildDefaultServiceConfiguration ( ) const

inlineprotectedinherited

A string describing the full default parameter set.

Definition at line 315 of file unit_test_base.h.

    {
      return BuildServiceConfiguration(services_default_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::BuildDefaultTestConfiguration ( ) const

inlineprotectedinherited

A string describing the full default parameter set.

Definition at line 321 of file unit_test_base.h.

    {
      return BuildTestConfiguration(analyzers_default_cfg);
    }

static std::string testing::BasicEnvironmentConfiguration::BuildServiceConfiguration ( ConfigurationMap_t const &  services )

inlinestaticprotectedinherited

A string with the service section from service parameter sets.

Definition at line 333 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += "\nservices: {";
      for (auto const& service_info : services) {
        cfg += "\n  " + service_info.first + ": {";
        cfg += "\n" + service_info.second;
        cfg += "\n  } # " + service_info.first;
      } // for services
      cfg += "\n} # services"
             "\n";
      return cfg;
    } // BuildServiceConfiguration()

static std::string testing::BasicEnvironmentConfiguration::BuildTestConfiguration ( ConfigurationMap_t const &  analyzers )

inlinestaticprotectedinherited

A string with the physics section from analyzer parameter sets.

Definition at line 348 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += "\nphysics: {"
             "\n  analyzers: {";
      for (auto const& module_info : analyzers) {
        cfg += "\n  " + module_info.first + ": {";
        cfg += "\n" + module_info.second;
        cfg += "\n  } # " + module_info.first;
      } // for analyzers
      cfg += "\n  } # analyzers"
             "\n} # physics";
      return cfg;
    } // BuildServiceConfiguration()

std::string testing::BasicEnvironmentConfiguration::ConfigurationPath ( ) const

inlineinherited

Path to the configuration file.

Definition at line 155 of file unit_test_base.h.

{ return config_path; }

static std::string testing::BasicEnvironmentConfiguration::DefaultApplicationName ( )

inlinestaticprotectedinherited

Returns the default test name.

Definition at line 271 of file unit_test_base.h.

{ return "Test"; }

std::string testing::BasicEnvironmentConfiguration::DefaultConfiguration ( ) const

inlineinherited

A string describing the full default parameter set.

Definition at line 195 of file unit_test_base.h.

{ return BuildDefaultConfiguration(); }

template<typename CHANNELMAP >

std::string testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::DefaultGeometryConfiguration ( ) const

inline

A string describing the default parameter set to configure geometry.

Definition at line 101 of file geometry_unit_test_base.h.

References testing::BasicEnvironmentConfiguration::DefaultServiceConfiguration(), and testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryServiceName().

    {
      return DefaultServiceConfiguration(GeometryServiceName());
    }

void testing::BasicEnvironmentConfiguration::DefaultInit ( )

inlineprotectedinherited

Initialize with some default values.

Definition at line 291 of file unit_test_base.h.

References mf::SetApplicationName().

    {
      SetApplicationName(DefaultApplicationName());
      SetMainTesterParameterSetName("");
      // a destination which will react to all messages from DEBUG up:
      AddDefaultServiceConfiguration("message",
                                     R"(
           debugModules: [ '*' ]
           destinations : {
             stdout: {
               type:      cout
               threshold: DEBUG
               categories: {
                 default: {
                   limit: -1
                 }
               } // categories
             } // stdout
             statistics: {type:cout}
           } // destinations
         )");
    } // DefaultInit()

std::string testing::BasicEnvironmentConfiguration::DefaultServiceConfiguration ( std::string  service_name ) const

inlineinherited

A string describing the default parameter set to configure the test.

Definition at line 189 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::DefaultGeometryConfiguration().

    {
      return services_default_cfg.at(service_name);
    }

std::string testing::BasicEnvironmentConfiguration::DefaultTesterConfiguration ( std::string  tester_name ) const

inlineinherited

A string describing default parameter set to configure specified test.

Definition at line 183 of file unit_test_base.h.

    {
      return analyzers_default_cfg.at(tester_name);
    }

std::vector<std::string> const& testing::BasicEnvironmentConfiguration::EexcutableArguments ( ) const

inlineinherited

Returns the list of non-Boost-test arguments on the command line.

Definition at line 201 of file unit_test_base.h.

{ return arguments.Arguments(); }

std::string testing::BasicEnvironmentConfiguration::ExecutablePath ( ) const

inlineinherited

Returns the name of the executable as started.

Definition at line 198 of file unit_test_base.h.

{ return arguments.Executable(); }

template<typename CHANNELMAP >

std::string testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryParameterSetPath ( ) const

inline

A string describing the default parameter set to configure geometry.

Definition at line 95 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryServiceName(), and testing::BasicEnvironmentConfiguration::ServiceParameterSetPath().

    {
      return ServiceParameterSetPath(GeometryServiceName());
    }

template<typename CHANNELMAP >

static std::string testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryServiceName ( )

inlinestatic

Returns the name of the service.

Definition at line 126 of file geometry_unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::DefaultGeometryConfiguration(), testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryParameterSetPath(), testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetDefaultGeometryConfiguration(), and testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetGeometryParameterSetPath().

{ return "Geometry"; }

template<typename CHANNELMAP >

void testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit ( )

inlineprotected

Initialize with some default values.

Definition at line 130 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetDefaultGeometryConfiguration().

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::BasicGeometryEnvironmentConfiguration().

    {
      SetDefaultGeometryConfiguration(R"(
          SurfaceY:        200.  # in cm, vertical distance to the surface
          Name:            "lartpcdetector"
          GDML:            "LArTPCdetector.gdml"
          ROOT:            "LArTPCdetector.gdml"
          SortingParameters: {}  # empty parameter set for default
          )");
    } // LocalInit()

std::string testing::BasicEnvironmentConfiguration::MainTesterParameterSetName ( ) const

inlineinherited

Name of the test algorithm instance.

Definition at line 165 of file unit_test_base.h.

{ return main_test_name; }

std::string testing::BasicEnvironmentConfiguration::MainTesterParameterSetPath ( ) const

inlineinherited

FHiCL path for the configuration of the test algorithm.

Definition at line 168 of file unit_test_base.h.

    {
      return MainTesterParameterSetName().empty() ?
               "" :
               TesterParameterSetPath(MainTesterParameterSetName());
    }

void testing::BasicEnvironmentConfiguration::ParseCommandLine ( int  argc, char **  argv  )

inlineprotectedinherited

Extracts arguments from the command line, uses first one as config path.

Definition at line 284 of file unit_test_base.h.

    {
      arguments.ParseArguments(argc, argv);
      if (arguments.hasArgument(0)) SetConfigurationPath(arguments.Argument(0)); // first argument
    }

std::string testing::BasicEnvironmentConfiguration::ServiceParameterSetPath ( std::string  name ) const

inlineinherited

FHiCL path for the configuration of the service.

Definition at line 176 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryParameterSetPath().

    {
      auto iPath = service_paths.find(name);
      return (iPath == service_paths.end()) ? ("services." + name) : iPath->second;
    } // ServiceParameterSetPath()

void testing::BasicEnvironmentConfiguration::SetApplicationName ( std::string  name )

inlineinherited

Sets the name of the application.

Definition at line 209 of file unit_test_base.h.

{ appl_name = name; }

void testing::BasicEnvironmentConfiguration::SetConfigurationPath ( std::string  path )

inlineinherited

Sets the path to the configuration file.

Definition at line 212 of file unit_test_base.h.

{ config_path = path; }

template<typename CHANNELMAP >

void testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetDefaultGeometryConfiguration ( std::string  cfg )

inline

Sets a string describing the default parameter set to configure geometry.

Definition at line 118 of file geometry_unit_test_base.h.

References testing::BasicEnvironmentConfiguration::AddDefaultServiceConfiguration(), and testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryServiceName().

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::LocalInit().

    {
      AddDefaultServiceConfiguration(GeometryServiceName(), cfg);
    }

template<typename CHANNELMAP >

void testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetGeometryParameterSetPath ( std::string  path )

inline

Sets the FHiCL path for the geometry configuration.

Definition at line 112 of file geometry_unit_test_base.h.

References testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::GeometryServiceName(), and testing::BasicEnvironmentConfiguration::SetServiceParameterSetPath().

    {
      SetServiceParameterSetPath(GeometryServiceName(), path);
    }

void testing::BasicEnvironmentConfiguration::SetMainTesterParameterSetName ( std::string  name )

inlineinherited

Sets the FHiCL name for the configuration of the test algorithm.

Definition at line 215 of file unit_test_base.h.

{ main_test_name = name; }

void testing::BasicEnvironmentConfiguration::SetMainTesterParameterSetPath ( std::string  path )

inlineinherited

Sets the FHiCL path for the configuration of the main test algorithm.

Definition at line 224 of file unit_test_base.h.

References util::empty().

    {
      if (MainTesterParameterSetName().empty()) {
        throw std::logic_error("Request setting configuration of non-existent main tester");
      }
      SetTesterParameterSetPath(MainTesterParameterSetName(), path);
    }

void testing::BasicEnvironmentConfiguration::SetServiceParameterSetPath ( std::string  service_name, std::string  path  )

inlineinherited

Sets the FHiCL path for the configuration of a test algorithm.

Definition at line 233 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration< CHANNELMAP >::SetGeometryParameterSetPath().

    {
      service_paths[service_name] = path;
    }

void testing::BasicEnvironmentConfiguration::SetTesterParameterSetPath ( std::string  test_name, std::string  path  )

inlineinherited

Sets the FHiCL path for the configuration of a test algorithm.

Definition at line 218 of file unit_test_base.h.

    {
      test_paths[test_name] = path;
    }

std::string testing::BasicEnvironmentConfiguration::TesterParameterSetPath ( std::string  name ) const

inlineinherited

FHiCL path for the configuration of the test algorithm.

Definition at line 158 of file unit_test_base.h.

    {
      auto iPath = test_paths.find(name);
      return (iPath == test_paths.end()) ? ("physics.analyzers." + name) : iPath->second;
    }

Member Data Documentation

ConfigurationMap_t testing::BasicEnvironmentConfiguration::analyzers_default_cfg

protectedinherited

Configuration of all the analyzer modules.

Definition at line 276 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::appl_name

protectedinherited

name of the application

Definition at line 265 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::config_path

protectedinherited

configuration file path

Definition at line 266 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::main_test_name

protectedinherited

name of main test algorithm

Definition at line 267 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::main_test_path

protectedinherited

path of main test algorithm configuration

Definition at line 268 of file unit_test_base.h.

PathMap_t testing::BasicEnvironmentConfiguration::service_paths

protectedinherited

Set of paths for service configuration.

Definition at line 281 of file unit_test_base.h.

ConfigurationMap_t testing::BasicEnvironmentConfiguration::services_default_cfg

protectedinherited

Configuration of all the services.

Definition at line 274 of file unit_test_base.h.

PathMap_t testing::BasicEnvironmentConfiguration::test_paths

protectedinherited

Set of paths for tester configuration.

Definition at line 279 of file unit_test_base.h.

---

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

• larcorealg/v09_13_01/source/larcorealg/TestUtils/geometry_unit_test_base.h