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
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...
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...

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

Protected Member Functions
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...

Additional Inherited Members
Protected Types inherited from testing::BasicEnvironmentConfiguration
using	ConfigurationMap_t = std::map< std::string, std::string >
using	PathMap_t = std::map< std::string, std::string >
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>
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 70 of file geometry_unit_test_base.h.

Member Typedef Documentation

template<typename CHANNELMAP>

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

Definition at line 73 of file geometry_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 76 of file geometry_unit_test_base.h.

                                           :
      BasicEnvironmentConfiguration()
      { LocalInit(); }

template<typename CHANNELMAP>

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

inline

Constructor: acquires parameters from the command line.

Definition at line 81 of file geometry_unit_test_base.h.

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

template<typename CHANNELMAP>

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

inline

Constructor; accepts the name as parameter.

Definition at line 86 of file geometry_unit_test_base.h.

                                                         :
      BasicEnvironmentConfiguration(name)
      { LocalInit(); }

template<typename CHANNELMAP>

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

inline

Definition at line 91 of file geometry_unit_test_base.h.

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

Member Function Documentation

template<typename CHANNELMAP>

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

inline

A string describing the default parameter set to configure geometry.

Definition at line 103 of file geometry_unit_test_base.h.

      { return DefaultServiceConfiguration(GeometryServiceName()); }

template<typename CHANNELMAP>

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

inline

Definition at line 99 of file geometry_unit_test_base.h.

      { return ServiceParameterSetPath(GeometryServiceName()); }

template<typename CHANNELMAP>

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

inlinestatic

Returns the name of the service.

Definition at line 124 of file geometry_unit_test_base.h.

{ return "Geometry"; }

template<typename CHANNELMAP>

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

inlineprotected

Initialize with some default values.

Definition at line 129 of file geometry_unit_test_base.h.

      {
        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()

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 117 of file geometry_unit_test_base.h.

      { 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 113 of file geometry_unit_test_base.h.

      { SetServiceParameterSetPath(GeometryServiceName(), path); }

---

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

• geometry_unit_test_base.h

---

Generated by   1.8.5