Commentable.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef BPP_SEQ_COMMENTABLE_H
#define BPP_SEQ_COMMENTABLE_H
 
 
// From the STL:
#include <string>
#include <iostream>
 
namespace bpp
{
typedef std::vector<std::string> Comments;
 
class Commentable
{
public:
  Commentable() {}
  virtual ~Commentable() {}
 
  virtual const Comments& getComments() const = 0;
 
  virtual void setComments(const Comments& comments) = 0;
 
  virtual void clearComments() = 0;
};
 
class SimpleCommentable :
  public virtual Commentable
{
protected:
  Comments comments_;
 
public:
  SimpleCommentable() :
    comments_()
  {}
 
  SimpleCommentable(const Comments& comments) :
    comments_(comments)
  {}
 
  SimpleCommentable(const SimpleCommentable& com) :
    comments_(com.comments_)
  {}
 
  SimpleCommentable& operator=(const SimpleCommentable& com)
  {
    comments_ = com.comments_;
    return *this;
  }
 
  virtual ~SimpleCommentable()
  {}
 
  const Comments& getComments() const override { return comments_; }
 
  void setComments(const Comments& comments) override { comments_ = comments; }
 
  void clearComments() override { comments_.clear(); }
};
} // end of namespace bpp.
#endif // BPP_SEQ_COMMENTABLE_H