ATLAS Offline Software
Public Member Functions | Protected Member Functions | Friends | List of all members
ISignalState Class Referenceabstract

#include <ISignalState.h>

Inheritance diagram for ISignalState:
Collaboration diagram for ISignalState:

Public Member Functions

virtual ~ISignalState ()
 virtual destructor needed More...
 
virtual P4SignalState::State signalState () const =0
 obtain the current signal state More...
 
virtual CLHEP::HepLorentzVector hlv (P4SignalState::State s) const =0
 obtain the CLHEP HepLorentzVector More...
 
virtual bool hasSignalState (P4SignalState::State s) const =0
 check if signal state exists for current implementation More...
 
virtual bool isAtSignalState (P4SignalState::State s) const =0
 check if we are at the passed state More...
 

Protected Member Functions

virtual bool setSignalState (P4SignalState::State s)=0
 set the current signal state More...
 
virtual void resetSignalState ()=0
 reset the signal state More...
 

Friends

class SignalStateHelper
 make friends! More...
 
class SignalStateConstHelper
 

Detailed Description

ISignalState is an abstract base class providing support for various Signal States to be associated with an object. In the case of Jets and CaloClusters, Signal States correspond to different calibrations, represented by their respective four-vectors.

Author
Pierre-Antoine Delsart <delsart AT in2p3.fr>
Pier-Olivier DeViveiros <viveiros AT physics.utoronto.ca>
Peter Loch <loch AT physics.arizona.edu>

Definition at line 41 of file ISignalState.h.

Constructor & Destructor Documentation

◆ ~ISignalState()

ISignalState::~ISignalState ( )
virtual

virtual destructor needed

Definition at line 28 of file ISignalState.cxx.

29 {}

Member Function Documentation

◆ hasSignalState()

virtual bool ISignalState::hasSignalState ( P4SignalState::State  s) const
pure virtual

◆ hlv()

virtual CLHEP::HepLorentzVector ISignalState::hlv ( P4SignalState::State  s) const
pure virtual

◆ isAtSignalState()

virtual bool ISignalState::isAtSignalState ( P4SignalState::State  s) const
pure virtual

◆ resetSignalState()

virtual void ISignalState::resetSignalState ( )
protectedpure virtual

◆ setSignalState()

virtual bool ISignalState::setSignalState ( P4SignalState::State  s)
protectedpure virtual

◆ signalState()

virtual P4SignalState::State ISignalState::signalState ( ) const
pure virtual

obtain the current signal state

Implemented in CaloCluster, and ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >.

Friends And Related Function Documentation

◆ SignalStateConstHelper

friend class SignalStateConstHelper
friend

Definition at line 70 of file ISignalState.h.

◆ SignalStateHelper

friend class SignalStateHelper
friend

make friends!

Definition at line 69 of file ISignalState.h.


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