util::EventChangeTracker_t Class Reference

Detects the presence of a new event. More...

#include <ChangeTrackers.h>

Inheritance diagram for util::EventChangeTracker_t:

Classes
struct	LocalState_t

Public Member Functions
	EventChangeTracker_t ()=default
	Default constructor: no current event, next event is a new one. More...
	EventChangeTracker_t (art::Event const &evt)
	Constructor: current event as specified. More...
	EventChangeTracker_t (art::EventID const &evt_id)
	Constructor: current event as specified by the event ID. More...
	operator std::string () const
	Returns a string representing the current state. More...
State query
Returns whether this tracker is in the same state as another
bool	same (EventChangeTracker_t const &as) const
bool	isValid () const
	Returns whether there is a current event. More...
bool	operator== (EventChangeTracker_t const &as) const
	Returns whether this tracker is in the same state as another. More...
bool	operator!= (EventChangeTracker_t const &than) const
	Returns whether this tracker is in a different state than another. More...
State change
Forgets the current event
void	clear ()
void	set (art::EventID const &evt_id)
	Sets the current event ID. More...
void	set (art::Event const &evt)
	Sets the current event ID from the given event. More...
bool	update (EventChangeTracker_t const &trk)
	Sets the current event, and returns true if it is changed. More...

Protected Member Functions
art::EventID const &	eventID () const
	Returns the current event ID (it might be made public...) More...

Private Attributes
LocalState_t	state
	local state of the tracker (may inherit some more) More...

Detailed Description

Detects the presence of a new event.

---

The state of this class describes the current event by its ID.

Definition at line 32 of file ChangeTrackers.h.

Constructor & Destructor Documentation

util::EventChangeTracker_t::EventChangeTracker_t ( )

default

Default constructor: no current event, next event is a new one.

util::EventChangeTracker_t::EventChangeTracker_t ( art::Event const &  evt )

inline

Constructor: current event as specified.

Definition at line 38 of file ChangeTrackers.h.

: state{evt.id()} {}

util::EventChangeTracker_t::EventChangeTracker_t ( art::EventID const &  evt_id )

inline

Constructor: current event as specified by the event ID.

Definition at line 41 of file ChangeTrackers.h.

: state{evt_id} {}

Member Function Documentation

void util::EventChangeTracker_t::clear ( )

inline

Definition at line 63 of file ChangeTrackers.h.

{ set(art::EventID()); }

art::EventID const& util::EventChangeTracker_t::eventID ( ) const

inlineprotected

Returns the current event ID (it might be made public...)

Definition at line 91 of file ChangeTrackers.h.

{ return state.event_id; }

bool util::EventChangeTracker_t::isValid ( ) const

inline

Returns whether there is a current event.

Definition at line 50 of file ChangeTrackers.h.

{ return eventID() != art::EventID(); }

util::EventChangeTracker_t::operator std::string ( ) const

inline

Returns a string representing the current state.

Definition at line 81 of file ChangeTrackers.h.

      {
        return "R:" + std::to_string(eventID().run())
          + " S:" + std::to_string(eventID().subRun())
          + " E:" + std::to_string(eventID().event());
      }

bool util::EventChangeTracker_t::operator!= ( EventChangeTracker_t const &  than ) const

inline

Returns whether this tracker is in a different state than another.

Definition at line 56 of file ChangeTrackers.h.

      { return !same(than); }

bool util::EventChangeTracker_t::operator== ( EventChangeTracker_t const &  as ) const

inline

Returns whether this tracker is in the same state as another.

Definition at line 53 of file ChangeTrackers.h.

{ return same(as); }

bool util::EventChangeTracker_t::same ( EventChangeTracker_t const &  as ) const

inline

Definition at line 46 of file ChangeTrackers.h.

      { return as.eventID() == eventID(); }

void util::EventChangeTracker_t::set ( art::EventID const &  evt_id )

inline

Sets the current event ID.

Definition at line 66 of file ChangeTrackers.h.

{ state.event_id = evt_id; }

void util::EventChangeTracker_t::set ( art::Event const &  evt )

inline

Sets the current event ID from the given event.

Definition at line 69 of file ChangeTrackers.h.

{ set(evt.id()); }

bool util::EventChangeTracker_t::update ( EventChangeTracker_t const &  trk )

inline

Sets the current event, and returns true if it is changed.

Definition at line 72 of file ChangeTrackers.h.

      {
        if (same(trk)) return false;
        *this = trk;
        return true;
      }

Member Data Documentation

LocalState_t util::EventChangeTracker_t::state

private

local state of the tracker (may inherit some more)

Definition at line 99 of file ChangeTrackers.h.

---

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

• ChangeTrackers.h