Processor Class Reference

Ratpac-two: Processor Class Reference
Ratpac-two
Processor Class Reference

#include <Processor.hh>

Detailed Description

Base class for all processors.

Author
Stan Seibert volsu.nosp@m.ng@p.nosp@m.hysic.nosp@m.s.ut.nosp@m.exas..nosp@m.edu

A Processor represents a chunk of analysis code that can be placed into the event loop by the user. It is constructed in the macro when the user calls:

/rat/proc procname 

The user can then configure the processor with the macro command:

/rat/procset variable_name variable_value 

This is translated into calls to SetI(), SetF(), SetD(), or SetS() depending upon the detected type of variable_value. If there is a problem, ParamUnknown or ParamInvalid exceptions are thrown.

Once the event loop starts, DSEvent() called once per physics event. If you would rather run once per triggered event (of which there can be zero or more associated with a physics event), then override the Event() method, and the default implementation of DSEvent() will call Event() once for every triggered event.

To create a new processor, subclass Processor and then edit ProcBlockManager::ProcBlockManager().


The documentation for this class was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/core/include/RAT/Processor.hh