ATLAS Offline Software
|
#include <FeatureRequestDescriptor.h>
Public Member Functions | |
FeatureRequestDescriptor (const std::string &chainGroupName="HLT_.*", const unsigned int condition=TrigDefs::Physics, const std::string &containerSGKey="", const unsigned int featureCollectionMode=TrigDefs::lastFeatureOfType, const std::string &navElementLinkKey=TrigCompositeUtils::featureString(), const int restrictToLegIndex=-1) | |
Default Constructor supplying all properties. More... | |
FeatureRequestDescriptor (const std::string &chainGroupName) | |
Constructor for a specific Chain or Chain Group, supplied by name. More... | |
~FeatureRequestDescriptor ()=default | |
Default destructor. More... | |
FeatureRequestDescriptor (FeatureRequestDescriptor &&)=default | |
Default move constructor. More... | |
FeatureRequestDescriptor (const FeatureRequestDescriptor &)=default | |
Default copy constructor. More... | |
void | reset () |
Reset the FeatureRequestDescriptor to its default configuration. More... | |
void | print (MsgStream &msg, const MSG::Level level=MSG::INFO) |
Print the configuration of the FeatureRequestDescriptor to the supplied message stream. More... | |
FeatureRequestDescriptor & | setChainGroup (const std::string &chainGroupName) |
Set the desired Chain or Chain Group. More... | |
FeatureRequestDescriptor & | setCondition (const unsigned int condition) |
Set the Condition: TrigDefs::Physics - (default), only returns features from paths through the navigation which accepted the event for at least one of the chains in the ChainGroup. More... | |
FeatureRequestDescriptor & | setRequireSGKey (const std::string &containerSGKey) |
Set the StoreGate key filter. More... | |
FeatureRequestDescriptor & | setFeatureCollectionMode (const unsigned int featureCollectionMode) |
Set the Feature Collection Mode: TrigDefs::lastFeatureOfType - (default) stop exploring up each path through the navigation as soon as one ElementLink has been collected along the path. More... | |
FeatureRequestDescriptor & | setLinkName (const std::string &navElementLinkKey) |
Set the Link Name Key. More... | |
FeatureRequestDescriptor & | setRestrictRequestToLeg (const int restrictToLegIndex) |
Set to -1 by default, indicating that all legs of multi-leg chains are searched. More... | |
const std::string & | chainGroup () const |
unsigned int | condition () const |
const std::string & | SGKey () const |
unsigned int | featureCollectionMode () const |
const std::string & | linkName () const |
int | restrictRequestToLeg () const |
Private Attributes | |
std::string | m_chainGroupName |
int | m_condition |
std::string | m_containerSGKey |
int | m_featureCollectionMode |
std::string | m_navElementLinkKey |
int | m_restrictToLegIndex |
Definition at line 37 of file FeatureRequestDescriptor.h.
Trig::FeatureRequestDescriptor::FeatureRequestDescriptor | ( | const std::string & | chainGroupName = "HLT_.*" , |
const unsigned int | condition = TrigDefs::Physics , |
||
const std::string & | containerSGKey = "" , |
||
const unsigned int | featureCollectionMode = TrigDefs::lastFeatureOfType , |
||
const std::string & | navElementLinkKey = TrigCompositeUtils::featureString() , |
||
const int | restrictToLegIndex = -1 |
||
) |
Default Constructor supplying all properties.
See below for individual property descriptions.
Definition at line 10 of file FeatureRequestDescriptor.cxx.
Trig::FeatureRequestDescriptor::FeatureRequestDescriptor | ( | const std::string & | chainGroupName | ) |
Constructor for a specific Chain or Chain Group, supplied by name.
Regex supported.
Definition at line 25 of file FeatureRequestDescriptor.cxx.
|
default |
Default destructor.
No heap allocations.
|
default |
Default move constructor.
|
default |
Default copy constructor.
const std::string & Trig::FeatureRequestDescriptor::chainGroup | ( | ) | const |
Definition at line 119 of file FeatureRequestDescriptor.cxx.
unsigned int Trig::FeatureRequestDescriptor::condition | ( | ) | const |
Definition at line 124 of file FeatureRequestDescriptor.cxx.
unsigned int Trig::FeatureRequestDescriptor::featureCollectionMode | ( | ) | const |
Definition at line 134 of file FeatureRequestDescriptor.cxx.
const std::string & Trig::FeatureRequestDescriptor::linkName | ( | ) | const |
Definition at line 139 of file FeatureRequestDescriptor.cxx.
void Trig::FeatureRequestDescriptor::print | ( | MsgStream & | msg, |
const MSG::Level | level = MSG::INFO |
||
) |
Print the configuration of the FeatureRequestDescriptor to the supplied message stream.
Definition at line 41 of file FeatureRequestDescriptor.cxx.
void Trig::FeatureRequestDescriptor::reset | ( | ) |
Reset the FeatureRequestDescriptor to its default configuration.
Definition at line 31 of file FeatureRequestDescriptor.cxx.
int Trig::FeatureRequestDescriptor::restrictRequestToLeg | ( | ) | const |
Definition at line 144 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setChainGroup | ( | const std::string & | chainGroupName | ) |
Set the desired Chain or Chain Group.
Regex supported.
Definition at line 77 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setCondition | ( | const unsigned int | condition | ) |
Set the Condition: TrigDefs::Physics - (default), only returns features from paths through the navigation which accepted the event for at least one of the chains in the ChainGroup.
TrigDefs::includeFailedDecisions - follows more paths through the navigation, the paths which were active for at least one of the chains in the ChainGroup, but which failed for all of these chains by some non-final Step.
Definition at line 83 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setFeatureCollectionMode | ( | const unsigned int | featureCollectionMode | ) |
Set the Feature Collection Mode: TrigDefs::lastFeatureOfType - (default) stop exploring up each path through the navigation as soon as one ElementLink has been collected along the path.
As all paths are explored from their last step backwards, this equates to collecting the "final" feature along each path (after accounting for all other filtering options). TrigDefs::allFeatureOfType - does not stop once an ElementLink is collected when exploring paths through the navigation, instead keeps exploring always back to the L1 node. Potentially returns many features along each path, corresponding to intermediate physics objects as well as the "final" physics object.
Definition at line 98 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setLinkName | ( | const std::string & | navElementLinkKey | ) |
Set the Link Name Key.
Sets which named-edges in the navigation graph are returned by the call. By default the TrigDecisionTool looks for edges named "feature", however "roi", "initialRoI" or slice-specific custom-named edges can be alternatively used here.
Definition at line 107 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setRequireSGKey | ( | const std::string & | containerSGKey | ) |
Set the StoreGate key filter.
ElementLinks will have their StoreGate collection key checked against this filter, it must match for the ElementLink to be collected. Regex supported. Set to an empty string (default) to disable the filter.
Definition at line 92 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setRestrictRequestToLeg | ( | const int | restrictToLegIndex | ) |
Set to -1 by default, indicating that all legs of multi-leg chains are searched.
If set to an integer >= 0, the search will be restricted to the single specified leg for all chains in the ChainGroup.
Definition at line 113 of file FeatureRequestDescriptor.cxx.
const std::string & Trig::FeatureRequestDescriptor::SGKey | ( | ) | const |
Definition at line 129 of file FeatureRequestDescriptor.cxx.
|
private |
Definition at line 173 of file FeatureRequestDescriptor.h.
|
private |
Definition at line 174 of file FeatureRequestDescriptor.h.
|
private |
Definition at line 175 of file FeatureRequestDescriptor.h.
|
private |
Definition at line 176 of file FeatureRequestDescriptor.h.
|
private |
Definition at line 177 of file FeatureRequestDescriptor.h.
|
private |
Definition at line 178 of file FeatureRequestDescriptor.h.