ISignalState Class Reference

ISignalState is an abstract base class providing support for various Signal States to be associated with an object. More...

#include <ISignalState.h>

Inheritance diagram for ISignalState:

Collaboration diagram for ISignalState:

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

Protected Member Functions
virtual bool	setSignalState (P4SignalState::State s)=0
	set the current signal state
virtual void	resetSignalState ()=0
	reset the signal state

Friends
class	SignalStateHelper
	make friends!
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.

{}

Member Function Documentation

hasSignalState()

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

pure virtual

check if signal state exists for current implementation

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

hlv()

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

pure virtual

obtain the CLHEP HepLorentzVector

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

isAtSignalState()

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

pure virtual

check if we are at the passed state

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

resetSignalState()

virtual void ISignalState::resetSignalState ( )

protectedpure virtual

reset the signal state

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

setSignalState()

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

protectedpure virtual

set the current signal state

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

signalState()

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

pure virtual

obtain the current signal state

Implemented in CaloCluster, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

Friends And Related Symbol 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:

• ISignalState.h
• ISignalState.cxx