#include <FeatureRequestDescriptor.h>

Collaboration diagram for Trig::FeatureRequestDescriptor:

Public Member Functions
	FeatureRequestDescriptor (const std::string &chainGroupName="", 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 except for the chain group.
	~FeatureRequestDescriptor ()=default
	Default destructor.
	FeatureRequestDescriptor (FeatureRequestDescriptor &&)=default
	Default move constructor.
	FeatureRequestDescriptor (const FeatureRequestDescriptor &)=default
	Default copy constructor.
void	reset ()
	Reset the FeatureRequestDescriptor to its default configuration.
void	print (MsgStream &msg, const MSG::Level level=MSG::INFO)
	Print the configuration of the FeatureRequestDescriptor to the supplied message stream.
FeatureRequestDescriptor &	setChainGroup (const std::string &chainGroupName)
	Set the desired Chain or Chain Group.
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.
FeatureRequestDescriptor &	setRequireSGKey (const std::string &containerSGKey)
	Set the StoreGate key filter.
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.
FeatureRequestDescriptor &	setLinkName (const std::string &navElementLinkKey)
	Set the Link Name Key.
FeatureRequestDescriptor &	setRestrictRequestToLeg (const int restrictToLegIndex)
	Set to -1 by default, indicating that all legs of multi-leg chains are searched.
const std::string &	chainGroup () const
unsigned int	condition () const
const std::string &	SGKey () const
const std::regex &	SGKeyExpression () 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
std::regex	m_containerSGKeyExpression
int	m_featureCollectionMode
std::string	m_navElementLinkKey
int	m_restrictToLegIndex

Detailed Description

Definition at line 26 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

Constructor & Destructor Documentation

◆ FeatureRequestDescriptor() [1/3]

Trig::FeatureRequestDescriptor::FeatureRequestDescriptor	(	const std::string &	chainGroupName = "",
		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 except for the chain group.

See below for individual property descriptions.

Parameters

[in] chainGroupName Chain or Chain Group, supplied by name. Regex supported for chainGroupName with TrigDecisionTool. Only one exact individual chain name is supported in TrigDecisionToolLite.

Definition at line 10 of file FeatureRequestDescriptor.cxx.

                                    {
    setChainGroup(chainGroupName);
    setCondition(condition);
    setRequireSGKey(containerSGKey);
    setFeatureCollectionMode(featureCollectionMode);
    setLinkName(navElementLinkKey);
    setRestrictRequestToLeg(restrictToLegIndex);
  }

◆ ~FeatureRequestDescriptor()

Trig::FeatureRequestDescriptor::~FeatureRequestDescriptor ( )

default

Default destructor.

No heap allocations.

◆ FeatureRequestDescriptor() [2/3]

Trig::FeatureRequestDescriptor::FeatureRequestDescriptor ( FeatureRequestDescriptor && )

default

Default move constructor.

◆ FeatureRequestDescriptor() [3/3]

Trig::FeatureRequestDescriptor::FeatureRequestDescriptor ( const FeatureRequestDescriptor & )

default

Default copy constructor.

Member Function Documentation

◆ chainGroup()

const std::string & Trig::FeatureRequestDescriptor::chainGroup ( ) const

Returns: String corresponding to the chain group. Will be mapped to an actual ChainGroup by the TrigDecisionTool.

Definition at line 117 of file FeatureRequestDescriptor.cxx.

                                                              {
    if (m_chainGroupName.empty()) {
      throw std::runtime_error("FeatureRequestDescriptor::chainGroup() No chain group string was supplied to this FeatureRequestDescriptor.");
    }
    return m_chainGroupName;
  }

◆ condition()

unsigned int Trig::FeatureRequestDescriptor::condition ( ) const

Returns: The Condition, TrigDefs::Physics or TrigDefs::includeFailedDecisions

Definition at line 125 of file FeatureRequestDescriptor.cxx.

                                                         {
    return m_condition;
  }

◆ featureCollectionMode()

unsigned int Trig::FeatureRequestDescriptor::featureCollectionMode ( ) const

Returns: The feature collection mode, TrigDefs::lastFeatureOfType or TrigDefs::allFeatureOfType

Definition at line 140 of file FeatureRequestDescriptor.cxx.

                                                                     {
    return m_featureCollectionMode;
  }

◆ linkName()

const std::string & Trig::FeatureRequestDescriptor::linkName ( ) const

Returns: The name of the edges in the navigation graph which will be collected and returned.

Definition at line 145 of file FeatureRequestDescriptor.cxx.

                                                            {
    return m_navElementLinkKey;
  }

◆ print()

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 35 of file FeatureRequestDescriptor.cxx.

                                                                           {
    msg << level << "Feature Request Descriptor configuration:" << endmsg;
    msg << level << "-- Chain Group name:'" << chainGroup() << "'." << endmsg;
    if (chainGroup().empty()) {
      msg << MSG::ERROR << "Empty chain group name " << endmsg;
    }
    if (condition() == TrigDefs::Physics) {
      msg << level << "-- Condition: TrigDefs::Physics, only paths which accepted chains in the ChainGroup will be explored." << endmsg;
    } else if (condition() == TrigDefs::includeFailedDecisions) {
      msg << level << "-- Condition: TrigDefs::includeFailedDecisions, passed and failed paths for chains in the ChainGroup will be explored." << endmsg;
    } else {
      msg << MSG::ERROR << "-- Unknown condition: " << condition() << endmsg;
    }
    if (SGKey().empty()) {
      msg << level << "-- No filtering on Container StoreGate Key" << endmsg;
    } else {
      msg << level << "-- Container StoreGate Key: ElementLinks must regex match the container name '" << SGKey() << "'." << endmsg;
    }
    if (featureCollectionMode() == TrigDefs::lastFeatureOfType) {
      msg << level << "-- Feature Collection Mode: TrigDefs::lastFeatureOfType, only one (final) matching ElementLink will be returned on each path through the navigation." << endmsg;
    } else if (featureCollectionMode() == TrigDefs::allFeaturesOfType) {
      msg << level << "-- Condition: TrigDefs::includeFailedDecisions, all matching ElementLinks will be returned on each path through the navigation." << endmsg;
    } else {
      msg << MSG::ERROR << "-- Unknown feature collection mode: " << featureCollectionMode() << "." << endmsg;
    }
    msg << level << "-- Link Name: ElementLinks referenced by graph edges named '" << linkName() << "' will be returned." << endmsg;
    if (restrictRequestToLeg() == -1) {
      msg << level << "-- Restrict Request To Leg: ElementLinks will be collected from all legs of any multi-leg chains in the ChainGroup." << endmsg;
    } else {
      msg << level << "-- Restrict Request To Leg: ElementLinks will be collected only from leg #" << restrictRequestToLeg() << " of all chains in the ChainGroup." << endmsg;
    }
  }

◆ reset()

void Trig::FeatureRequestDescriptor::reset ( )

Reset the FeatureRequestDescriptor to its default configuration.

Definition at line 24 of file FeatureRequestDescriptor.cxx.

                                       {
    m_chainGroupName = "";
    m_condition = TrigDefs::Physics;
    m_containerSGKey = "";
    m_containerSGKeyExpression = std::regex("");
    m_featureCollectionMode = TrigDefs::lastFeatureOfType;
    m_navElementLinkKey = TrigCompositeUtils::featureString();
    m_restrictToLegIndex = -1;
  }

◆ restrictRequestToLeg()

int Trig::FeatureRequestDescriptor::restrictRequestToLeg ( ) const

Returns: The chain-leg which the request is restricted to follow. -1 indicates no leg-specific filtering.

Definition at line 150 of file FeatureRequestDescriptor.cxx.

                                                           {
    return m_restrictToLegIndex;
  }

◆ setChainGroup()

FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setChainGroup ( const std::string & chainGroupName )

Set the desired Chain or Chain Group.

Regex supported with TrigDecisionTool. Only one exact individual chain name is supported in TrigDecisionToolLite.

Returns: reference to self, allows chaining.

Definition at line 74 of file FeatureRequestDescriptor.cxx.

                                                                                                   {
    m_chainGroupName = chainGroupName;
    return *this;
  }

◆ setCondition()

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.

Returns: reference to self, allows chaining.

Definition at line 80 of file FeatureRequestDescriptor.cxx.

                                                                                               {
    if (condition != TrigDefs::Physics and condition != TrigDefs::includeFailedDecisions) {
      throw std::runtime_error("Invalid option supplied to FeatureRequestDescriptor::setCondition. Must be Physics or includeFailedDecisions.");
    }
    m_condition = condition;
    return *this;
  }

◆ setFeatureCollectionMode()

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.

Returns: reference to self, allows chaining.

Definition at line 96 of file FeatureRequestDescriptor.cxx.

                                                                                                                       {
    if (featureCollectionMode != TrigDefs::lastFeatureOfType and featureCollectionMode != TrigDefs::allFeaturesOfType) {
      throw std::runtime_error("Invalid option supplied to FeatureRequestDescriptor::featureCollectionMode. Must be lastFeatureOfType or allFeaturesOfType.");
    }
    m_featureCollectionMode = featureCollectionMode;
    return *this;
  }

◆ setLinkName()

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.

Returns: reference to self, allows chaining.

Definition at line 105 of file FeatureRequestDescriptor.cxx.

                                                                                                    {
    m_navElementLinkKey = navElementLinkKey;
    return *this;
  }

◆ setRequireSGKey()

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.

Returns: reference to self, allows chaining.

Definition at line 89 of file FeatureRequestDescriptor.cxx.

                                                                                                     {
    m_containerSGKey = containerSGKey;
    m_containerSGKeyExpression = std::regex(containerSGKey);
    return *this;
  }

◆ setRestrictRequestToLeg()

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.

Returns: reference to self, allows chaining.

Definition at line 111 of file FeatureRequestDescriptor.cxx.

                                                                                                          {
    m_restrictToLegIndex = restrictToLegIndex;
    return *this;
  }

◆ SGKey()

const std::string & Trig::FeatureRequestDescriptor::SGKey ( ) const

Returns: The StoreGate key filter (regex). Or an empty string if no filtering is requested.

Definition at line 130 of file FeatureRequestDescriptor.cxx.

                                                         {
    return m_containerSGKey;
  }

◆ SGKeyExpression()

const std::regex & Trig::FeatureRequestDescriptor::SGKeyExpression ( ) const

Returns: The regex compiled StoreGate key filter.

Definition at line 135 of file FeatureRequestDescriptor.cxx.

                                                                  {
    return m_containerSGKeyExpression;
  }

Member Data Documentation

◆ m_chainGroupName

std::string Trig::FeatureRequestDescriptor::m_chainGroupName

private

Definition at line 156 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_condition

int Trig::FeatureRequestDescriptor::m_condition

private

Definition at line 157 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_containerSGKey

std::string Trig::FeatureRequestDescriptor::m_containerSGKey

private

Definition at line 158 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_containerSGKeyExpression

std::regex Trig::FeatureRequestDescriptor::m_containerSGKeyExpression

private

Definition at line 159 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_featureCollectionMode

int Trig::FeatureRequestDescriptor::m_featureCollectionMode

private

Definition at line 160 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_navElementLinkKey

std::string Trig::FeatureRequestDescriptor::m_navElementLinkKey

private

Definition at line 161 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

◆ m_restrictToLegIndex

int Trig::FeatureRequestDescriptor::m_restrictToLegIndex

private

Definition at line 162 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FeatureRequestDescriptor() [1/3]

◆ ~FeatureRequestDescriptor()

◆ FeatureRequestDescriptor() [2/3]

◆ FeatureRequestDescriptor() [3/3]

Member Function Documentation

◆ chainGroup()

◆ condition()

◆ featureCollectionMode()

◆ linkName()

◆ print()

◆ reset()

◆ restrictRequestToLeg()

◆ setChainGroup()

◆ setCondition()

◆ setFeatureCollectionMode()

◆ setLinkName()

◆ setRequireSGKey()

◆ setRestrictRequestToLeg()

◆ SGKey()

◆ SGKeyExpression()

Member Data Documentation

◆ m_chainGroupName

◆ m_condition

◆ m_containerSGKey

◆ m_containerSGKeyExpression

◆ m_featureCollectionMode

◆ m_navElementLinkKey

◆ m_restrictToLegIndex