IJetExecuteTool is a dual-use tool interface for generic tools, i.e. those that behave like algorithms. More...

#include <IJetExecuteTool.h>

Inherited by CopyTruthParticles, HIClusterSubtraction [virtual], HIEventShapeJetIteration [virtual], JetConstituentModSequence [virtual], JetDumper [virtual], JetInputElRemovalTool [virtual], JetReclusteringTool [virtual], JetRecTool [virtual], JetToolRunner [virtual], JetUsedInFitTrackDecoratorTool [virtual], MissingCellListTool [virtual], TrackVertexAssociationTool [virtual], and Validator [virtual].

Collaboration diagram for IJetExecuteTool:

Public Member Functions
virtual	~IJetExecuteTool ()
	Destructor. More...

virtual int	execute () const =0
	Method to be called for each event. More...

virtual int	inputContainerNames (std::vector< std::string > &connames)
	Method to return the list of input containers. More...

virtual int	outputContainerNames (std::vector< std::string > &connames)
	Method to return the list of output containers. More...

virtual void	print () const =0
	Print the state of the tool. More...

Detailed Description

IJetExecuteTool is a dual-use tool interface for generic tools, i.e. those that behave like algorithms.

Definition at line 19 of file IJetExecuteTool.h.

Constructor & Destructor Documentation

◆ ~IJetExecuteTool()

virtual IJetExecuteTool::~IJetExecuteTool ( )

inlinevirtual

Destructor.

Definition at line 25 of file IJetExecuteTool.h.

25 { };

Member Function Documentation

◆ execute()

virtual int IJetExecuteTool::execute ( ) const

pure virtual

Method to be called for each event.

Returns 0 for success.

Implemented in JetRecTool, JetReclusteringTool, HIEventShapeJetIteration, Validator, MissingCellListTool, JetDumper, JetConstituentModSequence, TrackVertexAssociationTool, JetInputElRemovalTool, HIClusterSubtraction, JetToolRunner, JetUsedInFitTrackDecoratorTool, CopyTruthJetParticles, and CopyTruthParticles.

◆ inputContainerNames()

int IJetExecuteTool::inputContainerNames ( std::vector< std::string > & connames )

virtual

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 11 of file IJetExecuteTool.cxx.

                                                               {
   return 0;
 }

◆ outputContainerNames()

int IJetExecuteTool::outputContainerNames ( std::vector< std::string > & connames )

virtual

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 17 of file IJetExecuteTool.cxx.

                                                                {
   return 0;
 }

◆ print()

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

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

Public Member Functions