KeyAbstract.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_KEY_KEYABSTRACT_HPP
#define __OPENTREP_KEY_KEYABSTRACT_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <sstream>
#include <string>

namespace OPENTREP {

  class KeyAbstract {
  public:
    // /////////// Display support methods /////////
    virtual void toStream (std::ostream&) const = 0;

    virtual void fromStream (std::istream&) = 0;

    virtual std::string toString() const = 0;
    
    virtual std::string describe() const = 0;

    
  protected:
    KeyAbstract() {}
    KeyAbstract (const KeyAbstract&) {}

    virtual ~KeyAbstract() {}
  };
}

template <class charT, class traits>
inline
std::basic_ostream<charT, traits>&
operator<< (std::basic_ostream<charT, traits>& ioOut,
            const OPENTREP::KeyAbstract& iKey) {
  std::basic_ostringstream<charT,traits> ostr;
  ostr.copyfmt (ioOut);
  ostr.width (0);

  // Fill string stream
  iKey.toStream (ostr);

  // Print string stream
  ioOut << ostr.str();

  return ioOut;
}

template <class charT, class traits>
inline
std::basic_istream<charT, traits>&
operator>> (std::basic_istream<charT, traits>& ioIn,
            OPENTREP::KeyAbstract& ioKey) {
  // Fill Key object with input stream
  ioKey.fromStream (ioIn);
  return ioIn;
}

#endif // __OPENTREP_KEY_KEYABSTRACT_HPP