TopologySearch.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef BPP_PHYL_TREE_TOPOLOGYSEARCH_H
#define BPP_PHYL_TREE_TOPOLOGYSEARCH_H
 
#include <Bpp/Clonable.h>
#include <Bpp/Exceptions.h>
 
 
// From the STL:
#include <string>
#include <vector>
 
namespace bpp
{
class TopologyChangeEvent
{
protected:
  std::string message_;
 
public:
  TopologyChangeEvent() : message_("") {}
  TopologyChangeEvent(const std::string& message) : message_(message) {}
  virtual ~TopologyChangeEvent() {}
 
public:
  virtual const std::string& getMessage() const { return message_; }
};
 
class TopologySearch;
 
class TopologyListener :
  public virtual Clonable
{
public:
  TopologyListener() {}
  virtual ~TopologyListener() {}
 
  TopologyListener* clone() const = 0;
 
public:
  virtual void topologyChangePerformed(const TopologyChangeEvent& event)
  {
    topologyChangeTested(event);
    topologyChangeSuccessful(event);
  }
 
  virtual void topologyChangeTested(const TopologyChangeEvent& event) = 0;
 
  virtual void topologyChangeSuccessful(const TopologyChangeEvent& event) = 0;
};
 
 
class TopologySearch
{
public:
  TopologySearch() {}
  virtual ~TopologySearch() {}
 
public:
  virtual void search() = 0;
 
  virtual void addTopologyListener(std::shared_ptr<TopologyListener> listener) = 0;
};
} // end of namespace bpp.
#endif // BPP_PHYL_TREE_TOPOLOGYSEARCH_H