ClassTraits.h

Go to the documentation of this file.

// -*- c++ -*-
 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef TRIGGER_DECISION_TOOL_ClassTraits_H
#define TRIGGER_DECISION_TOOL_ClassTraits_H
 
namespace TrigDec {
 
    // Here we define the trait classes.  The basic problem is
    // this:
    //
    // Some classes are attached to the navigation as basic objects
    // for example - MuonFeature
    // Other classes are attached to the navigation as containers of
    // objects for example - egamma's are attached as egammaContainers
    // Still other classes are not attached at all, but can be gotten
    // from the ancestor method in the TDT, such as the L1 items
    // We need to make this complexity invisible to the user, so they
    // can just call whatever they want to match to and not worry
    // about how it interacts with the navigation
    // We solve this with traits classes (thanks to Scott Snyder for
    // the suggestion) which tell us whether or not a class is a
    // container and if it is, allows us to map from the class to
    // the container class and similarly for ancest style objects
 
  struct DirectAttached {}; // identifies objects as attached directly
  struct AncestorAttached {}; // identifies objects as attached via ancest
 
    // by default, we assume a class is attached directly
    template<typename T>
    struct ClassTraits {
        typedef T type;
    };
 
}
    
// now we specialize for the container classes
 
// This macro specializes the definition of the
// ContainerForClass trait class
#define SPECIALIZE_CONTAINER_FOR_CLASS(x,y) \
    namespace TrigDec { \
        template<> \
        struct ClassTraits<x> { \
            typedef y type; \
        }; \
    }
 
// This macro does the forward declaration
// for objects without a namespace
#define DECLARE_ATTACHED_CONTAINER(x,y) \
    class x; \
    class y; \
    SPECIALIZE_CONTAINER_FOR_CLASS(x,y) 
 
// This macro does the forward declaration
// for objects with the same namespace
// as the container
#define DECLARE_ATTACHED_CONTAINER_NAMESPACE(a,x,y) \
    namespace a { \
        class x; \
        class y; \
    } \
    SPECIALIZE_CONTAINER_FOR_CLASS(a::x,a::y) 
 
// This macro does the forward declaration
// for objects with a namespace, but not namespace
// on the container
#define DECLARE_ATTACHED_CONTAINER_OBJECT_NAMESPACE(a,x,y) \
    namespace a { \
        class x; \
    } \
    class y; \
    SPECIALIZE_CONTAINER_FOR_CLASS(a::x,y) 
 
// This macro does the forward declaration
// for objects with a namespace, and containers
// that are a typedef
#define DECLARE_ATTACHED_CONTAINER_TYPEDEF(a, x, y) \
    namespace a { \
        class x; \
    } \
    SPECIALZE_CONTAINER_FOR_CLASS(a::x, y)
 
    DECLARE_ATTACHED_CONTAINER(CaloCell, CaloCellContainer)
    //DECLARE_ATTACHED_CONTAINER(CosmicMuon, CosmicMuonCollection)
    //DECLARE_ATTACHED_CONTAINER(MdtTrackSegment, MdtTrackSegmentCollection)
    DECLARE_ATTACHED_CONTAINER(TrigInDetTrack, TrigInDetTrackCollection)
    DECLARE_ATTACHED_CONTAINER(TrigVertex, TrigVertexCollection)
    DECLARE_ATTACHED_CONTAINER(CaloCluster, CaloClusterContainer)
    DECLARE_ATTACHED_CONTAINER(CaloShower, CaloShowerContainer)
    DECLARE_ATTACHED_CONTAINER(egamma, egammaContainer)
    DECLARE_ATTACHED_CONTAINER_NAMESPACE(Rec, TrackParticle, TrackParticleContainer)
    DECLARE_ATTACHED_CONTAINER_NAMESPACE(Analysis, TauDetails, TauDetailsContainer)
    DECLARE_ATTACHED_CONTAINER_NAMESPACE(Analysis, TauJet, TauJetContainer)
    DECLARE_ATTACHED_CONTAINER(Jet, JetCollection)
    DECLARE_ATTACHED_CONTAINER(CaloTower, CaloTowerContainer)
    DECLARE_ATTACHED_CONTAINER(egDetail, egDetailContainer)
    DECLARE_ATTACHED_CONTAINER_OBJECT_NAMESPACE(Trk, VxCandidate, VxContainer)
 
#undef SPECIALIZE_CONTAINER_FOR_CLASS
#undef DECLARE_ATTACHED_CONTAINER
#undef DECLARE_ATTACHED_CONTAINER_NAMESPACE
#undef DECLARE_ATTACHED_CONTAINER_TYPEDEF
#undef DECLARE_ATTACHED_CONTAINER_OBJECT_NAMESPACE
 
// now we set up the traits for the L1 items
 
// this macro setups a template specialization
// for the L1 objects
    /*
      #define DECLARE_L1_TRIGGER_OBJECT(x)  \
      class x;                  \
      namespace TrigDec {           \
      template<>                \
      struct ClassTraits<x> {           \
      typedef AncestorAttached type;        \
      };                    \
      }
      
      DECLARE_L1_TRIGGER_OBJECT(Muon_ROI)
      DECLARE_L1_TRIGGER_OBJECT(Jet_ROI)
      DECLARE_L1_TRIGGER_OBJECT(EmTau_ROI)
    */
#undef DECLARE_L1_TRIGGER_OBJECT
 
#endif