All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount > Struct Template Reference

#include <TriggerGateData.h>

Public Member Functions

constexpr TriggerGateStatus ()=default
 
constexpr TriggerGateStatus (TriggerGateEventType event, ClockTick tick, OpeningCount opening)
 
bool operator== (TriggerGateStatus const &other) const
 Comparison: are all fields matching? More...
 
bool operator!= (TriggerGateStatus const &other) const
 Comparison: is any field not matching? More...
 

Public Attributes

TriggerGateEventType event { TriggerGateEventType::Unknown }
 The event which yielded this status. More...
 
ClockTick tick { std::numeric_limits<ClockTick>::lowest() }
 When the status starts being valid. More...
 
OpeningCount opening { 0 }
 The total opening of the gate. More...
 

Static Public Attributes

static constexpr ClockTick MinTick = std::numeric_limits<ClockTick>::min()
 

Detailed Description

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
struct icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >

Definition at line 43 of file TriggerGateData.h.

Constructor & Destructor Documentation

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
constexpr icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::TriggerGateStatus ( )
default
template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
constexpr icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::TriggerGateStatus ( TriggerGateEventType  event,
ClockTick  tick,
OpeningCount  opening 
)
inline

Definition at line 59 of file TriggerGateData.h.

61  {}
ClockTick tick
When the status starts being valid.
TriggerGateEventType event
The event which yielded this status.
OpeningCount opening
The total opening of the gate.

Member Function Documentation

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
bool icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::operator!= ( TriggerGateStatus< ClockTick, OpeningCount > const &  other) const
inline

Comparison: is any field not matching?

Definition at line 71 of file TriggerGateData.h.

72  {
73  return (event != other.event)
74  || (tick != other.tick) || (opening != other.opening);
75  }
ClockTick tick
When the status starts being valid.
TriggerGateEventType event
The event which yielded this status.
OpeningCount opening
The total opening of the gate.
template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
bool icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::operator== ( TriggerGateStatus< ClockTick, OpeningCount > const &  other) const
inline

Comparison: are all fields matching?

Definition at line 64 of file TriggerGateData.h.

65  {
66  return (event == other.event)
67  && (tick == other.tick) && (opening == other.opening);
68  }
ClockTick tick
When the status starts being valid.
TriggerGateEventType event
The event which yielded this status.
OpeningCount opening
The total opening of the gate.

Member Data Documentation

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
TriggerGateEventType icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::event { TriggerGateEventType::Unknown }

The event which yielded this status.

Definition at line 49 of file TriggerGateData.h.

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
constexpr ClockTick icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::MinTick = std::numeric_limits<ClockTick>::min()
static

Definition at line 46 of file TriggerGateData.h.

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
OpeningCount icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::opening { 0 }

The total opening of the gate.

Definition at line 54 of file TriggerGateData.h.

template<typename ClockTick = unsigned int, typename OpeningCount = unsigned int>
ClockTick icarus::trigger::details::TriggerGateStatus< ClockTick, OpeningCount >::tick { std::numeric_limits<ClockTick>::lowest() }

When the status starts being valid.

Definition at line 52 of file TriggerGateData.h.


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