LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
detinfo::timescales::timescale_traits< TriggerTimeCategory > Struct Template Reference

Timing types for trigger electronics time scale. More...

#include "DetectorTimingTypes.h"

Inheritance diagram for detinfo::timescales::timescale_traits< TriggerTimeCategory >:
detinfo::timescales::details::timescale_traits_base< TriggerTimeCategory >

Public Types

using category_t = TriggerTimeCategory
 The category this time scale belongs to. More...
 
using time_interval_t = time_interval
 Type of a time interval in this scale. More...
 
using time_point_t = util::quantities::concepts::Point< util::quantities::microsecond, category_t, time_interval_t >
 Type of a point on this time scale. More...
 
using frequency_t = decltype(1.0/std::declval< typename time_interval_t::quantity_t >())
 Type of frequency for this time scale. More...
 
using tick_interval_t = util::quantities::concepts::Interval< util::quantities::tick, category_t >
 An interval on this time scale expressed in its ticks (integral). More...
 
using tick_interval_d_t = util::quantities::concepts::Interval< util::quantities::tick_d, category_t >
 An interval on this time scale expressed in its ticks (real). More...
 
using tick_t = util::quantities::concepts::Point< util::quantities::tick, category_t, tick_interval_t >
 A point on this time scale expressed in its ticks. More...
 
using tick_d_t = util::quantities::concepts::Point< util::quantities::tick_d, category_t, tick_interval_d_t >
 A point on this time scale expressed in its ticks (real). More...
 

Static Public Member Functions

static std::string name ()
 Name of this time scale. More...
 

Static Public Attributes

static constexpr bool same_category_as
 Returns whether the category OC is the same as this one. More...
 
static constexpr bool category_compatible_with
 Returns whether the category OC is compatible with this one. More...
 

Detailed Description

template<>
struct detinfo::timescales::timescale_traits< TriggerTimeCategory >

Timing types for trigger electronics time scale.

This object collects data types meant to represent a time on the trigger time axis, starting at the hardware trigger time.

This traits expose the interface documented in details::timescale_traits_base.

This time is natively expressed in microseconds.

Definition at line 244 of file DetectorTimingTypes.h.

Member Typedef Documentation

Type of frequency for this time scale.

Definition at line 122 of file DetectorTimingTypes.h.

Member Function Documentation

Name of this time scale.

Definition at line 141 of file DetectorTimingTypes.h.

141 { return category_t::name(); }

Member Data Documentation

constexpr bool detinfo::timescales::details::timescale_traits_base< TriggerTimeCategory , util::quantities::microsecond >::category_compatible_with
staticinherited

Returns whether the category OC is compatible with this one.

Definition at line 149 of file DetectorTimingTypes.h.

Returns whether the category OC is the same as this one.

Definition at line 145 of file DetectorTimingTypes.h.


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