IBunchCrossingTool.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// $Id: IBunchCrossingTool.h 618301 2014-09-24 08:53:05Z krasznaa $
#ifndef TRIGANALYSISINTERFACES_IBUNCHCROSSINGTOOL_H
#define TRIGANALYSISINTERFACES_IBUNCHCROSSINGTOOL_H
 
// STL include(s):
#include <vector>
 
// Gaudi/Athena include(s):
#include "AsgTools/IAsgTool.h"

namespace Trig {

   class IBunchCrossingTool : public virtual asg::IAsgTool {

      ASG_TOOL_INTERFACE( Trig::IBunchCrossingTool )
 
   public:
      typedef unsigned int bcid_type;


      virtual bool isFilled( bcid_type bcid = 0 ) const = 0;


      virtual bool isInTrain( bcid_type bcid = 0 ) const = 0;


      virtual bool isUnpaired( bcid_type bcid = 0 ) const = 0;


      virtual bool isBeam1( bcid_type bcid = 0 ) const = 0;


      virtual bool isBeam2( bcid_type bcid = 0 ) const = 0;


      enum BeamType {
         Beam1    = 0, 
         Beam2    = 1, 
         Crossing = 2  
      };


      virtual float bcIntensity( bcid_type bcid = 0,
                                 BeamType type = Crossing ) const = 0;


      enum BunchCrossingType {
         Empty = 0, 
         FirstEmpty = 1, 
         MiddleEmpty = 2, 
         Single = 100, 
         Front = 200, 
         Middle = 201, 
         Tail = 202, 
         Unpaired = 300 
      };


      virtual BunchCrossingType bcType( bcid_type bcid = 0 ) const = 0;


      enum BunchDistanceType {
         NanoSec, 
         BunchCrossings, 
         FilledBunches
      };


      virtual
      int distanceFromFront( bcid_type bcid = 0,
                             BunchDistanceType type = NanoSec ) const = 0;

      virtual
      int distanceFromTail( bcid_type bcid = 0,
                            BunchDistanceType type = NanoSec ) const = 0;


      virtual int gapBeforeTrain( bcid_type bcid = 0,
                                  BunchDistanceType type = NanoSec ) const = 0;

      virtual int gapAfterTrain( bcid_type bcid = 0,
                                 BunchDistanceType type = NanoSec ) const = 0;


      enum BunchFillType {
         CollidingBunch = 0,
         UnpairedBunch  = 1,
         EmptyBunch     = 2,
         UnpairedBeam1  = 3,
         UnpairedBeam2  = 4
      };


      virtual
      int gapBeforeBunch( bcid_type bcid = 0,
                          BunchDistanceType dtype = NanoSec,
                          BunchFillType ftype = CollidingBunch ) const = 0;


      virtual
      int gapAfterBunch( bcid_type bcid = 0,
                         BunchDistanceType dtype = NanoSec,
                         BunchFillType ftype = CollidingBunch ) const = 0;


      virtual std::vector< bool > bunchesInFront( bcid_type bcid = 0,
                                                  int bunches = 10 ) const = 0;


      virtual std::vector< bool > bunchesAfter( bcid_type bcid = 0,
                                                int bunches = 10 ) const = 0;


      virtual std::vector< float >
      bunchIntInFront( bcid_type bcid = 0,
                       int bunches = 10,
                       BeamType type = Crossing ) const = 0;


      virtual std::vector< float >
      bunchIntAfter( bcid_type bcid = 0,
                     int bunches = 10,
                     BeamType type = Crossing ) const = 0;


      virtual unsigned int numberOfFilledBunches() const = 0;


      virtual unsigned int numberOfUnpairedBunches() const = 0;


      virtual unsigned int numberOfBunchTrains() const = 0;


      virtual
      int bunchTrainSpacing( BunchDistanceType type = NanoSec ) const = 0;
 
   }; // class IBunchCrossingTool
 
} // namespace Trig
 
#endif // TRIGANALYSISINTERFACES_IBUNCHCROSSINGTOOL_H