artdaq::NthEventPolicy Class Reference

An example RoutingMasterPolicy which redirects every Nth event to a desginated destination. Other events are Round-Robin'ed to the other configured destinations. More...

Inheritance diagram for artdaq::NthEventPolicy:

Public Member Functions
	NthEventPolicy (fhicl::ParameterSet ps)
	NthEventPolicy Constructor. More...
detail::RoutingPacket	GetCurrentTable () override
	Construct a Routing Table using the current tokens. More...

Detailed Description

An example RoutingMasterPolicy which redirects every Nth event to a desginated destination. Other events are Round-Robin'ed to the other configured destinations.

Definition at line 13 of file NthEvent_policy.cc.

Constructor & Destructor Documentation

artdaq::NthEventPolicy::NthEventPolicy ( fhicl::ParameterSet  ps )

explicit

NthEventPolicy Constructor.

Parameters

ps	ParameterSet used to configure the NthEventPolicy

* NthEventPolicy accepts the following Parameters:
* "nth_event" (REQUIRED): Every event where sequence_id % nth == 0 will be sent to
* "target_receiver" (REQUIRED): Recevier to which the nth_event will be sent
* 

Definition at line 36 of file NthEvent_policy.cc.

Member Function Documentation

detail::RoutingPacket artdaq::NthEventPolicy::GetCurrentTable ( )

overridevirtual

Construct a Routing Table using the current tokens.

Returns

A detail::RoutingPacket with the table. The table will contain full "turns" through the set of "regular" receivers, with the "nth" receiver inserted where sequence_id % nth == 0. If nth is mid-"turn" and no target_receiver tokens are availabe, it will not start the "turn".

Implements artdaq::RoutingMasterPolicy.

Definition at line 50 of file NthEvent_policy.cc.

---

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

• artdaq_demo/artdaq-demo/RoutingPolicies/NthEvent_policy.cc