ParameterAliasable.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_NUMERIC_PARAMETERALIASABLE_H
#define BPP_NUMERIC_PARAMETERALIASABLE_H


#include "ParameterExceptions.h"
#include "ParameterList.h"
#include "Parametrizable.h"

// From the STL:
#include <string>
#include <map>

namespace bpp
{
class ParameterAliasable :
  public virtual Parametrizable
{
public:
  ParameterAliasable() {}
  virtual ~ParameterAliasable() {}

public:
  virtual size_t getNumberOfIndependentParameters() const = 0;

  virtual void aliasParameters(const std::string& p1, const std::string& p2) = 0;

  virtual void aliasParameters(std::map<std::string, std::string>& unparsedParams, bool verbose) = 0;

  virtual void unaliasParameters(const std::string& p1, const std::string& p2)  = 0;

  virtual const ParameterList& getIndependentParameters() const = 0;

  virtual std::vector<std::string> getAlias(const std::string& name) const = 0;

  virtual std::map<std::string, std::string> getAliases() const = 0;
};


class ParameterAliasableAdapter :
  public ParametrizableAdapter
{
public:
  ParameterAliasableAdapter() {}
  virtual ~ParameterAliasableAdapter() {}

public:
  const ParameterList& getIndependentParameters() const { return getParameters(); }
  void aliasParameters(const std::string& p1, const std::string& p2) {}
  void unaliasParameters(const std::string& p1, const std::string& p2) {}
  unsigned int getNumberOfIndependentParameters() const { return 0; }
  std::vector<std::string> getAlias(const std::string& name) const { return std::vector<std::string>(); }
  std::map<std::string, std::string> getAliases() const { return std::map<std::string, std::string>(); }
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PARAMETERALIASABLE_H