sumdata::GeometryConfigurationInfo Struct Reference

Description of the current configuration of detector geometry. More...

#include "GeometryConfigurationInfo.h"

Public Types
using	DataVersion_t = unsigned int
	Type used for the version of data. More...

Public Member Functions
bool	isDataValid () const noexcept
	Protocol: whether the data content is valid. More...

Public Attributes
DataVersion_t	dataVersion = InvalidDataVersion
	Version of the data in this object (0 is invalid version). More...
std::string	geometryServiceConfiguration
	geo::Geometry service configuration, as FHiCL table. More...
std::string	detectorName

Static Public Attributes
static constexpr DataVersion_t	InvalidDataVersion = 0U
	Value denoting an invalid data version. More...

Detailed Description

Description of the current configuration of detector geometry.

This data class contains enough information to determine if the detector geometry configuration it describes is compatible with another one.

The version of the data is explicitly included, so that the software can determine which is the most complete test possible when the version of the input is older than the current one.

The information in this object should be as compact as possible to avoid bloating the data files it is stored into. Currently, three categories of information are included:

• the version of this data (just a monotonically increasing integral value);
• the full configuration of Geometry service as a string;
• selected information for easier access

Note

The logic determining the compatibility between two sumdata::GeometryConfigurationInfo objects is not part of the object definition and it is delegated to the appropriate algorithms.

Versions

1. legacy version; includes
   • the version (1)
   • detector name (geo::Geometry::DetectorName())
2. includes version 1 information and:
   • the configuration of geo::Geometry service as a FHiCL string

Definition at line 57 of file GeometryConfigurationInfo.h.

Member Typedef Documentation

using sumdata::GeometryConfigurationInfo::DataVersion_t = unsigned int

Type used for the version of data.

Definition at line 59 of file GeometryConfigurationInfo.h.

Member Function Documentation

bool sumdata::GeometryConfigurationInfo::isDataValid ( ) const

inlinenoexcept

Protocol: whether the data content is valid.

Definition at line 74 of file GeometryConfigurationInfo.h.

References InvalidDataVersion.

Referenced by geo::Geometry::CompareConfigurationInfo(), and sumdata::operator<<().

{ return dataVersion != InvalidDataVersion; }

Member Data Documentation

DataVersion_t sumdata::GeometryConfigurationInfo::dataVersion = InvalidDataVersion

Version of the data in this object (0 is invalid version).

Definition at line 65 of file GeometryConfigurationInfo.h.

Referenced by geo::Geometry::CompareConfigurationInfo(), geo::GeometryConfigurationWriter::convertRunDataToGeometryInformation(), geo::Geometry::FillGeometryConfigurationInfo(), and sumdata::operator<<().

std::string sumdata::GeometryConfigurationInfo::detectorName

Definition at line 71 of file GeometryConfigurationInfo.h.

Referenced by geo::Geometry::CompareConfigurationInfo(), geo::GeometryConfigurationWriter::convertRunDataToGeometryInformation(), and geo::Geometry::FillGeometryConfigurationInfo().

std::string sumdata::GeometryConfigurationInfo::geometryServiceConfiguration

geo::Geometry service configuration, as FHiCL table.

Name of the geometry (geo::GeometryCore::DetectorName()).

Definition at line 68 of file GeometryConfigurationInfo.h.

Referenced by geo::Geometry::FillGeometryConfigurationInfo().

constexpr DataVersion_t sumdata::GeometryConfigurationInfo::InvalidDataVersion = 0U

static

Value denoting an invalid data version.

Definition at line 62 of file GeometryConfigurationInfo.h.

Referenced by isDataValid().

---

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

• larcoreobj/v09_10_01/source/larcoreobj/SummaryData/GeometryConfigurationInfo.h