SGFolder.h

Go to the documentation of this file.

// -*- c++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef SGCOMPS_FOLDER_H
#define SGCOMPS_FOLDER_H 1
 
#include <string>
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/IClassIDSvc.h"
#include "GaudiKernel/ServiceHandle.h"
 
#include "SGTools/SGIFolder.h"
 
namespace SG {
  class Folder_tester;

  class Folder : public extends<AthAlgTool, IFolder>
  {
  public:

    Folder(const std::string& type,
       const std::string& name,
       const IInterface* parent);
    virtual ~Folder() override;

    typedef IFolder::ItemList ItemList;


    typedef IFolder::const_iterator const_iterator;
    virtual const_iterator begin() const override { return m_list.begin(); }
    virtual const_iterator end() const override { return m_list.end(); }

    virtual StatusCode add(const std::string& typeName, const std::string& skey) override;
    virtual StatusCode add(const CLID& clid, const std::string& skey) override {
      const bool DONTCHECKVALIDCLID(false);
      return add(clid, skey, DONTCHECKVALIDCLID, false);
    }

    virtual void clear() override { m_list.clear(); }
 

    virtual void updateItemList(bool checkValidCLID) override final;


    virtual StatusCode initialize() override;
 
  private:
 
    ServiceHandle<IClassIDSvc> m_pCLIDSvc;
 
    BooleanProperty m_checkItems{this, "CheckItems", false, "check if item types are known to ClassIDSvc"};
 
    StringArrayProperty m_itemList{this, "ItemList", {}, &Folder::decodeItemList,
      "List of data objects identified by a class name (or clid)#key pairs. One can use '*' as key value to "
      "add all objects of a given type to the Folder. If the type name ends with !, then write the object as "
      "exactly that type (and not as any derived class)."};
 
    void decodeItemList(Gaudi::Details::PropertyBase&) {
      const bool DONTCHECKVALIDCLID(false);
      Folder::updateItemList(DONTCHECKVALIDCLID); 
    }
    void decodeItem(const std::string& item, bool checkValidCLID);
    friend class Folder_tester;
    StatusCode add(const CLID& clid, const std::string& skey, 
           bool checkValidCLID, bool exact);
 
    ItemList m_list;
 
  };
} //ns SG
 
#endif