LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | List of all members
detinfo::DetectorClocks Class Referenceabstract

Class used for the conversion of times between different formats and references. More...

#include "DetectorClocks.h"

Inheritance diagram for detinfo::DetectorClocks:
detinfo::DetectorClocksStandard

Public Member Functions

virtual ~DetectorClocks ()=default
 
virtual std::vector< std::string > const & ConfigNames () const =0
 
virtual std::vector< double > const & ConfigValues () const =0
 
virtual DetectorClocksData DataForJob () const =0
 Returns a complete detinfo::DetectorClocksData object. More...
 
virtual DetectorClocksData DataFor (double g4_ref_time, double trigger_time, double beam_time) const =0
 Returns a complete detinfo::DetectorClocksData object. More...
 

Detailed Description

Class used for the conversion of times between different formats and references.

detinfo::DetectorClocks is an abstract interface enclosing the set of supported queries. A concrete implementation of this interface needs to be provided in order to use this facility. LArSoft provides detinfo::DetectorClocksStandard as a simple, reasonable implementation. Initialization and configuration are designed by each implementation.

The only use of this provider in LArSoft version 9 and newer is to provide an instance of detinfo::DetectorClocksData containing all the relevant information.

Helper functions may be available to extract the necessary information from specific implementations of detinfo::DetectorClocks.

Definition at line 52 of file DetectorClocks.h.

Constructor & Destructor Documentation

virtual detinfo::DetectorClocks::~DetectorClocks ( )
virtualdefault

Member Function Documentation

virtual std::vector<std::string> const& detinfo::DetectorClocks::ConfigNames ( ) const
pure virtual

Returns a list of provider configuration names.

See also
ConfigValues()

Implemented in detinfo::DetectorClocksStandard.

virtual std::vector<double> const& detinfo::DetectorClocks::ConfigValues ( ) const
pure virtual

Returns a list of provider configuration values (same order as ConfigNames()).

See also
ConfigNames()

Implemented in detinfo::DetectorClocksStandard.

virtual DetectorClocksData detinfo::DetectorClocks::DataFor ( double  g4_ref_time,
double  trigger_time,
double  beam_time 
) const
pure virtual

Returns a complete detinfo::DetectorClocksData object.

Parameters
g4_ref_timestart of simulation time in electronics time scale [ns]
trigger_timethe default hardware trigger time in electronics time
beam_timethe default beam gate opening time in electronics time

The returned timing information reflects the current context, defined by the parameters passed to this method.

If the information required by the parameters is not available, users will be forced to use DataForJob() instead.

For more details on the definition of the parameters, see the documentation of detinfo::DetectorClocksData constructor.

Implemented in detinfo::DetectorClocksStandard.

virtual DetectorClocksData detinfo::DetectorClocks::DataForJob ( ) const
pure virtual

Returns a complete detinfo::DetectorClocksData object.

The returned timing information is based on information independent of the current input file, run or event. It is recommended that DataFor() is used instead whenever possible.

Implemented in detinfo::DetectorClocksStandard.

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