Variables
canvas/doc/PARAMETERS.txt File Reference

Variables

and for the C binding for FHiCL
 
and for the C binding for for a description of how the parameter values associated with these parameter names are available to C programs Top level names
 
and for the C binding for for a description of how the parameter values associated with these parameter names are available to C programs Top level and are not nested within any other structure
 
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *sourcetable
 
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is specified
 
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is the only parameter required names the type of source to be used
 
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is the only parameter required names the type of source to be *filters *outputs *and *producers *tables are used to define the names of modules instances of each of the given categories that are to be created
 
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is the only parameter required names the type of source to be *filters *outputs *and *producers *tables are used to define the names of modules instances of each of the given categories that are to be and to specify their configurations The vectors *trigger_paths *and *end_paths *are used to identify which is the variety of each path Any other name is assumed to be the name of a path
 

Variable Documentation

services supplied by experiments are configured by parameters in the contained table named* user* The suggested type for those parameters is* table which is beyond the scope of this document Names in the* source an* EmptySource* configured to deliver one event is constructed If a* source* table is the only parameter required names the type of source to be * filters * outputs* and* producers* tables are used to define the names of modules instances of each of the given categories that are to be created

Definition at line 126 of file PARAMETERS.txt.

and for the C binding for FHiCL

Definition at line 1 of file PARAMETERS.txt.

and for the C binding for for a description of how the parameter values associated with these parameter names are available to C programs Top level names
Initial value:
===============
that appear directly in the configuration document
these are all by getting the vString this is set to true if debugModules is non empty everyDebugEnabled_ is a global scope variable instantiated as false in MessageLogger cc In the ctor of this is set to true if nay one of debugModules is *debugEnabledModules_ contains the specified debugModules If debugEnabled is set to then the effect of LogDebug used during that module is to immediately return A subtlety arose concerning the MessageDrop in circumstances where the framework s event processing structure were not in play In if preModule were never then debugEnabled would remain whatever value it had on construction of the MessageDrop the value was left uninitialized Now it is initialized to true in the ctor for we change debugEnabled MessageDrop s debugEnabled to false Configuring Destinations The each destination has its own tables of what to do about each category and but we get various overall defaults fromm the cfg file as well The limit instructions at the MessageLogger level takes on forms in order of priority of these to be used for messages who have no established limit for their specific categries A default to be used for messages not falling then there is no limit and all messages of that type will be reported Thresholds are having just an overall default and possible destination specific thresholds A threshold says if a message is below this severity level
these are all by getting the vString this is set to true if debugModules is non empty everyDebugEnabled_ is a global scope variable instantiated as false in MessageLogger cc In the ctor of this is set to true if nay one of debugModules is *debugEnabledModules_ contains the specified debugModules If debugEnabled is set to then the effect of LogDebug used during that module is to immediately return A subtlety arose concerning the MessageDrop in circumstances where the framework s event processing structure were not in play In if preModule were never then debugEnabled would remain whatever value it had on construction of the MessageDrop the value was left uninitialized Now it is initialized to true in the ctor for we change debugEnabled MessageDrop s debugEnabled to false Configuring Destinations The each destination has its own tables of what to do about each category and but we get various overall defaults fromm the cfg file as well The limit instructions at the MessageLogger level takes on forms in order of priority of these are
has to become something that gets invoked directly
and for the C binding for for a description of how the parameter values associated with these parameter names are available to C programs Top level names
Definition: PARAMETERS.txt:29
the code is simple for that
This add method has three it adds this message xid and id to the appropriate and it updates the dynamic information in counts The sequence is as the static apppropriate and timespan will be in the mapped CountAndLimit and there will be no need to recompute them If this xid is not yet in see if the category is in limits if the appropriate counts struct can be formed by using the precedence rules above to combine the limit and interval found in limits along with the severityLimits and severityIntervals arrays found in the ELlimitsTable Along the way the limits map for this category is filled in

Definition at line 29 of file PARAMETERS.txt.

services supplied by experiments are configured by parameters in the contained table named* user* The suggested type for those parameters is* table which is beyond the scope of this document Names in the* source an* EmptySource* configured to deliver one event is constructed If a* source* table is the only parameter required names the type of source to be * filters * outputs* and* producers* tables are used to define the names of modules instances of each of the given categories that are to be and to specify their configurations The vectors* trigger_paths* and* end_paths* are used to identify which is the variety of each path Any other name is assumed to be the name of a path

Definition at line 126 of file PARAMETERS.txt.

services supplied by experiments are configured by parameters in the contained table named* user* The suggested type for those parameters is* table which is beyond the scope of this document Names in the* source an* EmptySource* configured to deliver one event is constructed If a* source* table is specified

Definition at line 112 of file PARAMETERS.txt.

and for the C binding for for a description of how the parameter values associated with these parameter names are available to C programs Top level and are not nested within any other structure
Initial value:
============ ==============
============ ==============
physics table
process_name string
services table
============ ==============
Names in the *services* table
=============================
The *services* table
all the services in an **art** program.
Services known to the **art** framework itself
are configured by parameters named in this table
these are all by getting the vString this is set to true if debugModules is non empty everyDebugEnabled_ is a global scope variable instantiated as false in MessageLogger cc In the ctor of this is set to true if nay one of debugModules is *debugEnabledModules_ contains the specified debugModules If debugEnabled is set to then the effect of LogDebug used during that module is to immediately return A subtlety arose concerning the MessageDrop in circumstances where the framework s event processing structure were not in play In if preModule were never then debugEnabled would remain whatever value it had on construction of the MessageDrop the value was left uninitialized Now it is initialized to true in the ctor for we change debugEnabled MessageDrop s debugEnabled to false Configuring Destinations The each destination has its own tables of what to do about each category and but we get various overall defaults fromm the cfg file as well The limit instructions at the MessageLogger level takes on forms in order of priority of these are
it is part of the same thread as the issuing message Thus when it sets up that info is available for stuffing into the ErrorObj or use in deciding whether to react to a LogDebug The information provided is
and must be present Because it has no parameters to configure
const char expected[]
Definition: Exception_t.cc:22
the ParameterSet object passed in for the configuration of a destination should be the only source that can affect the behavior of that destination This is to eliminate the dependencies of configuring a destination from multiple mostly from the defaults It suppresses possible glitches about changing the configuration file somewhere outside of a destination segament might still affect the behavior of that destination In the previous configuration for a specific the value of a certain e may come from following source
The tests in this directory tree as of have been extracted from the CMS MessageFacility so have been left operating *Tests that were in the top level test directory previously have been relegated to test Integation As noted by the directory these are not unit tests They are built but not executed as they require configuration files to be converted to fhiclcpp *Tests in and under test MessageService are neither built nor executed as they have multiple dependencies on the wider framework
Definition: README_TESTS.txt:8
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is the only parameter required names the type of source to be used
Definition: PARAMETERS.txt:126
HOW TO RUN THIS CODE by
these are called *plugin *libraries Plugin libraries are loaded by the *LibraryManager *see above The source file in which a module is implemented must be named< module > _plugin cc It must contain an invocation of the *DEFINE_EDM_PLUGIN *macro The *DEFINE_EDM_PLUGIN *macro is responsible for writing the appropriate *factory **function and that takes a const reference to a *ParameterSet *and that returns a newly created instance of the associated module type
one may need a pointer because the data members is *optional or because only the type of a *base class *is known
an exception should be thrown only if an ambiguous lookup is attempted It is an error to register more than one *factory function *for any long form name
This add method has three it adds this message xid and id to the appropriate and it updates the dynamic information in counts The sequence is as the static apppropriate and timespan will be in the mapped CountAndLimit and there will be no need to recompute them If this xid is not yet in see if the category is in limits if the appropriate counts struct can be formed by using the precedence rules above to combine the limit and interval found in limits along with the severityLimits and severityIntervals arrays found in the ELlimitsTable Along the way the limits map for this category is filled in
still a headache We still need to provide the flexibility currently offered by the cfg file In if a user wants to have completely different destination outputs
dictionary all
Flash Comparison #.
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source * table
Definition: PARAMETERS.txt:112
Running test cases Any parameters prefaced with Missing parameters

Definition at line 35 of file PARAMETERS.txt.

services supplied by experiments are configured by parameters in the contained table named* user* The suggested type for those parameters is* table which is beyond the scope of this document Names in the* source* table
Initial value:
===========================
the main source of event data input
for the program.
The contents required differ according to the module type
being configured.
it is part of the same thread as the issuing message Thus when it sets up that info is available for stuffing into the ErrorObj or use in deciding whether to react to a LogDebug The information provided is
and must be present Because it has no parameters to configure
the ParameterSet object passed in for the configuration of a destination should be the only source that can affect the behavior of that destination This is to eliminate the dependencies of configuring a destination from multiple mostly from the defaults It suppresses possible glitches about changing the configuration file somewhere outside of a destination segament might still affect the behavior of that destination In the previous configuration for a specific the value of a certain e may come from following source
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is the only parameter required names the type of source to be used
Definition: PARAMETERS.txt:126
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source an *EmptySource *configured to deliver one event is constructed If a *source *table is specified
Definition: PARAMETERS.txt:112
< separator(=)> module_type Type Source location< separator(-)> DummyAnalyzer analyzer< path > DummyAnalyzer_module cc DummyFilter filter< path > DummyFilter_module cc *DummyProducer producer< path > DummyProducer_module cc *DummyProducer producer< path > DummyProducer_module cc< separator(=)> The modules marked *above are degenerate i e specifying the short module_type value leads to an ambiguity In order to use a degenerate module
these are called *plugin *libraries Plugin libraries are loaded by the *LibraryManager *see above The source file in which a module is implemented must be named< module > _plugin cc It must contain an invocation of the *DEFINE_EDM_PLUGIN *macro The *DEFINE_EDM_PLUGIN *macro is responsible for writing the appropriate *factory **function and that takes a const reference to a *ParameterSet *and that returns a newly created instance of the associated module type
int main(int argc, char *argv[])
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source * table
Definition: PARAMETERS.txt:112

Definition at line 112 of file PARAMETERS.txt.

services supplied by experiments are configured by parameters in the contained table named* user* The suggested type for those parameters is* table which is beyond the scope of this document Names in the* source an* EmptySource* configured to deliver one event is constructed If a* source* table is the only parameter required names the type of source to be used
Initial value:
============ ==============
============ ==============
module_type string
============ ==============
Names in the *physics* table
============================
The entries in the *physics* table
control the actual work done by the program.
The *analyzers*
const char expected[]
Definition: Exception_t.cc:22
HOW TO RUN THIS CODE by
these are called *plugin *libraries Plugin libraries are loaded by the *LibraryManager *see above The source file in which a module is implemented must be named< module > _plugin cc It must contain an invocation of the *DEFINE_EDM_PLUGIN *macro The *DEFINE_EDM_PLUGIN *macro is responsible for writing the appropriate *factory **function and that takes a const reference to a *ParameterSet *and that returns a newly created instance of the associated module type
an exception should be thrown only if an ambiguous lookup is attempted It is an error to register more than one *factory function *for any long form name
This add method has three it adds this message xid and id to the appropriate and it updates the dynamic information in counts The sequence is as the static apppropriate and timespan will be in the mapped CountAndLimit and there will be no need to recompute them If this xid is not yet in see if the category is in limits if the appropriate counts struct can be formed by using the precedence rules above to combine the limit and interval found in limits along with the severityLimits and severityIntervals arrays found in the ELlimitsTable Along the way the limits map for this category is filled in
services supplied by experiments are configured by parameters in the contained table named *user *The suggested type for those parameters is *table which is beyond the scope of this document Names in the *source * table
Definition: PARAMETERS.txt:112

Definition at line 126 of file PARAMETERS.txt.