IDDescriptor.h

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation 
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : M.Frank
//
//==========================================================================
#ifndef DD4HEP_IDDESCRIPTOR_H
#define DD4HEP_IDDESCRIPTOR_H
 
// Framework include files
#include "DD4hep/Handle.h"
#include "DD4hep/BitFieldCoder.h"
 
// C++ include files
#include <string>
#include <vector>
#include <map>
 
namespace dd4hep {
 
  class IDDescriptorObject;
 
 
  class IDDescriptor: public Handle<IDDescriptorObject> {
  public:
    typedef BitFieldElement                                    Field;
    typedef std::vector<std::pair<std::string, const Field*> > FieldMap;
    typedef std::vector<std::pair<size_t, std::string> >       FieldIDs;
 
  public:
    IDDescriptor() = default;
    template <typename Q> IDDescriptor(const Handle<Q>& e) : Handle<Object>(e) { }
    IDDescriptor(const std::string& name, const std::string& description);
    std::string fieldDescription() const;
    unsigned maxBit() const;
    const FieldIDs& ids() const;
    const FieldMap& fields() const;
    const BitFieldElement* field(const std::string& field_name) const;
    size_t fieldID(const std::string& field_name) const;
    const BitFieldElement* field(size_t identifier) const;
#ifndef __MAKECINT__
    static VolumeID encode(const Field* fld, VolumeID value);
    VolumeID encode(const std::vector<std::pair<std::string, int> >& ids) const;
    VolumeID encode_reverse(const std::vector<std::pair<std::string, int> >& id_vector) const;
    VolumeID get_mask(const std::vector<std::pair<std::string, int> >& id_vector) const;
#endif
    void decodeFields(VolumeID vid, std::vector<std::pair<const BitFieldElement*, VolumeID> >& fields)  const;
    std::string str(VolumeID vid)  const;
    std::string str(VolumeID vid, VolumeID mask)  const;
    std::string toString() const;
    BitFieldCoder* decoder()  const;
    void rebuild(const std::string& description);
  };
}         /* End namespace dd4hep          */
#endif // DD4HEP_IDDESCRIPTOR_H