ModelDescription.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: $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/BaseModel.h>
#include <OpenMS/CONCEPT/Factory.h>
 
#include <sstream>
 
namespace OpenMS
{
  template <UInt D>
  class ModelDescription
  {
public:
 
    ModelDescription() :
      name_(),
      parameters_()
    {
    }
 
    ModelDescription(const ModelDescription & source) :
      name_(source.name_),
      parameters_(source.parameters_)
    {
    }
 
    ModelDescription(const BaseModel<D> * model) :
      name_(model->getName()),
      parameters_(model->getParameters())
    {
    }
 
    virtual ~ModelDescription()
    {
    }
 
    virtual ModelDescription & operator=(const ModelDescription & source)
    {
      if (&source == this) return *this;
 
      name_ = source.name_;
      parameters_ = source.parameters_;
 
      return *this;
    }
 
    BaseModel<D> * createModel()
    {
      if (name_.empty()) return nullptr;
 
      BaseModel<D> * model = Factory<BaseModel<D> >::create(name_);
      model->setParameters(parameters_);
      return model;
    }
 
    const String & getName() const
    {
      return name_;
    }
 
    String & getName()
    {
      return name_;
    }
 
    void setName(const String & name)
    {
      name_ = name;
    }
 
    const Param & getParam() const
    {
      return parameters_;
    }
 
    Param & getParam()
    {
      return parameters_;
    }
 
    void setParam(const Param & param)
    {
      parameters_ = param;
    }
 
    virtual bool operator==(const ModelDescription & rhs) const
    {
      return (name_ == rhs.name_) && (parameters_ == rhs.parameters_);
    }
 
    virtual bool operator!=(const ModelDescription & rhs) const
    {
      return !(operator==(rhs));
    }
 
 
protected:
 
    String name_;
    Param parameters_;
  };
}