StreamHandler.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Stephan Aiche$
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <map>
#include <iosfwd>
 
namespace OpenMS
{
  class OPENMS_DLLAPI StreamHandler
  {
public:
    enum StreamType
    {
      FILE,
      STRING
    };
 
    StreamHandler();
 
    virtual ~StreamHandler();
 
    Int registerStream(StreamType const type, const String & stream_name);
 
    void unregisterStream(StreamType const type, const String & stream_name);
 
    std::ostream & getStream(StreamType const type, const String & stream_name);
 
    bool hasStream(const StreamType type, const String & stream_name);
 
protected:
 
    std::map<String, std::ostream *>  name_to_stream_map_;  
    std::map<String, StreamType> name_to_type_map_;  
    std::map<String, Size>      name_to_counter_map_;   
 
    std::ostream * createStream_(const StreamType type, const String & stream_name);
 
private:
    // copy constructor and assignment operator are hidden to avoid
    // creating multiple pointers to a single filestream instance
 
    StreamHandler(const StreamHandler & source);
 
    virtual StreamHandler & operator=(const StreamHandler & source);
 
    friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, StreamHandler const & stream_handler);
  };
 
  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, StreamHandler const & stream_handler);
 
  OPENMS_DLLAPI extern StreamHandler STREAM_HANDLER;
} // end namespace OpenMS