Nymph  v1.5.2
Flow-Based Data Processing Framework
Public Member Functions | Private Attributes | List of all members
KTApplyCut Class Reference

Applies a cut to data. More...

#include <KTApplyCut.hh>

Inheritance diagram for KTApplyCut:
Inheritance graph

Public Member Functions

 KTApplyCut (const std::string &name="apply-cut")
 
virtual ~KTApplyCut ()
 
bool Configure (const scarab::param_node &node)
 Should perform parameter store and command-line configurations. More...
 
KTCutGetCut () const
 
void SetCut (KTCut *cut)
 
bool SelectCut (const std::string &cutName)
 
void ApplyCut (KTDataPtr)
 
- Public Member Functions inherited from KTProcessor
 KTProcessor (const std::string &name="default-proc-name")
 
virtual ~KTProcessor ()
 
void ConnectASlot (const std::string &signalName, KTProcessor *processor, const std::string &slotName, int groupNum=-1)
 
void ConnectASignal (KTProcessor *processor, const std::string &signalName, const std::string &slotName, int groupNum=-1)
 
void ConnectSignalToSlot (KTSignalWrapper *signal, KTSlotWrapper *slot, int groupNum=-1)
 
template<class XProcessor >
void RegisterSignal (std::string name, XProcessor *signalPtr)
 
template<class XTarget , typename XReturn >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)())
 
template<class XTarget , typename XReturn , typename XArg1 >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)(XArg1))
 
template<class XTarget , typename XReturn , typename XArg1 , typename XArg2 >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)(XArg1, XArg2))
 
KTSignalWrapperGetSignal (const std::string &name)
 
KTSlotWrapperGetSlot (const std::string &name)
 
template<typename XSignalSig >
void RegisterSignal (std::string name, XSignalSig *signalPtr)
 
- Public Member Functions inherited from KTConfigurable
 KTConfigurable (const std::string &name="default-name")
 
virtual ~KTConfigurable ()
 
bool Configure (const std::string &config)
 Implement the option for calling Configure without passing a parameter store node. More...
 
const std::string & GetConfigName () const
 
void SetConfigName (const std::string &name)
 

Private Attributes

KTCutfCut
 
KTSignalData fAfterCutSignal
 
KTSignalData fAfterCutPassSignal
 
KTSignalData fAfterCutFailSignal
 

Additional Inherited Members

- Protected Types inherited from KTProcessor
typedef std::map< std::string, KTSignalWrapper *> SignalMap
 
typedef SignalMap::iterator SigMapIt
 
typedef SignalMap::value_type SigMapVal
 
typedef std::map< std::string, KTSlotWrapper *> SlotMap
 
typedef SlotMap::iterator SlotMapIt
 
typedef SlotMap::value_type SlotMapVal
 
- Protected Attributes inherited from KTProcessor
SignalMap fSignalMap
 
SlotMap fSlotMap
 
- Protected Attributes inherited from KTConfigurable
KTCommandLineHandlerfCLHandler
 
std::string fConfigName
 

Detailed Description

Applies a cut to data.

Author
N. S. Oblath

KTApplyCut applies a cut to data – the type of cut and its parameters are specified at runtime from the set of cuts registered.

Only one cut can be applied by a given instance of KTApplyCut. To apply more than one cut, add another instance.

Interpretation of boolean returned by KTCut::Apply

Configuration name: "apply-cut"

Available configuration values:

Slots:

Signals:

Definition at line 54 of file KTApplyCut.hh.

Constructor & Destructor Documentation

◆ KTApplyCut()

KTApplyCut ( const std::string &  name = "apply-cut")

Definition at line 21 of file KTApplyCut.cc.

◆ ~KTApplyCut()

~KTApplyCut ( )
virtual

Definition at line 31 of file KTApplyCut.cc.

Member Function Documentation

◆ ApplyCut()

void ApplyCut ( KTDataPtr  dataPtr)

Definition at line 85 of file KTApplyCut.cc.

◆ Configure()

bool Configure ( const scarab::param_node &  node)
virtual

Should perform parameter store and command-line configurations.

Implements KTConfigurable.

Definition at line 36 of file KTApplyCut.cc.

◆ GetCut()

KTCut * GetCut ( ) const
inline

Definition at line 91 of file KTApplyCut.hh.

◆ SelectCut()

bool SelectCut ( const std::string &  cutName)

Definition at line 72 of file KTApplyCut.cc.

◆ SetCut()

void SetCut ( KTCut cut)

Definition at line 65 of file KTApplyCut.cc.

Member Data Documentation

◆ fAfterCutFailSignal

KTSignalData fAfterCutFailSignal
private

Definition at line 80 of file KTApplyCut.hh.

◆ fAfterCutPassSignal

KTSignalData fAfterCutPassSignal
private

Definition at line 79 of file KTApplyCut.hh.

◆ fAfterCutSignal

KTSignalData fAfterCutSignal
private

Definition at line 78 of file KTApplyCut.hh.

◆ fCut

KTCut* fCut
private

Definition at line 67 of file KTApplyCut.hh.


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