TBXMLWriterToolBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TBREC_TBXMLWRITERTOOLBASE_H
#define TBREC_TBXMLWRITERTOOLBASE_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include <iosfwd>
#include <vector>
#include <string>
#include <string_view>
 
class TBXMLWriterToolBase : public AthAlgTool
{
  // Constructors and Destructor //
 
 protected:
 
  TBXMLWriterToolBase(const std::string& type, const std::string& name,
              const IInterface* parent) 
    : AthAlgTool( type, name, parent )
    { }
 
 public:
 
  virtual ~TBXMLWriterToolBase()
    { } 
 
  // initialize
  virtual StatusCode initialize() override
    {
      return StatusCode::SUCCESS;
    }

  // Actions //
 
  //  template<typename DATA>
  virtual StatusCode writeOut( std::ostream& outStream, 
                   std::string_view entryTag = " " )
    {
      return this->writeEvent(outStream,entryTag);
    }
 
  virtual StatusCode finalize() override
    { 
      return StatusCode::SUCCESS;
    }
 
  virtual StatusCode finalize(std::ostream& outStream) 
   {
     this->closeAllElements(outStream);
     return this->finalize();
   }
 
 protected:

  // Client Implementation //
 
  virtual StatusCode writeRunFiles(const std::string& fileDir,
                   unsigned int runNumber) = 0;
  virtual StatusCode writeEvent(std::ostream& theFile,
                std::string_view entryTag) = 0;

  // Helpers //
 
  // dictionary management 
  virtual void openDictionary(std::ostream& outStream,
                  const std::string& dictName,
                  const std::vector<std::string>& listOfElements);
  virtual void openDictionary(std::ostream& outStream,
                  const std::string& dictName);
  virtual void closeDictionary(std::ostream& outStream);
 
  virtual void addDictElement(std::ostream& outStream,
                  const std::string& theElement,
                  const std::vector<std::string>& listOfElements);
  virtual void addAttributes(std::ostream& outStream,
                 const std::string& theElement,
                 const std::vector<std::string>& listOfAttributes);
 
  // element handling
  virtual void openElement(std::ostream& outStream,
               std::string_view theElement,
               const std::vector<std::string>& listOfAttr,
               const std::vector<std::string>& listOfValues);
  virtual void closeElement(std::ostream& outStream,
                const std::string& theElement);
  virtual void closeElement(std::ostream& outStream);
  virtual void closeAllElements(std::ostream& outStream);
  
  // Internal Data //
 
  std::vector<std::string> m_elementList;
  std::string              m_dictionary;
 
  static const std::string       m_doubleQuote;
};
#endif