FitObject.h

//
//  Copyright (C) 2017, Alexander Stukowski and Paul Erhart
//
//  This file is part of atomicrex.
//
//  Atomicrex is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 3 of the License, or
//  (at your option) any later version.
//
//  Atomicrex is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#pragma once

#include "../Atomicrex.h"
#include "../util/xml/XMLUtilities.h"

namespace atomicrex {

class FitJob;                   // Declared in FitJob.h
class DegreeOfFreedom;          // Declared in DegreeOfFreedom.h
class FitProperty;              // Declared in FitProperty.h

class FitObject : boost::noncopyable
{
protected:

    FitObject() {}

    FitObject(const FPString& id, FitJob* job, const FPString& tag = FPString()) :
        _id(id), _job(job), _tag(tag) {}

public:

    virtual ~FitObject() = default;

    /************************************ Weights **************************************/

    double relativeWeight() const { return _relativeWeight; }

    void setRelativeWeight(double weight) { _relativeWeight = weight; }

    virtual void assignAbsoluteWeights(double absoluteWeight);

    /*********************************** Properties ***********************************/

    virtual bool computeProperties(bool isFitting) { return true; }

    const std::vector<FitProperty*>& properties() const { return _fitPropertiesList; }

    void listAllProperties(std::vector<FitProperty*>& list) const;

    FitProperty* propertyById(const FPString& id) const;

    /************************************** DOFs ***************************************/

    const std::vector<DegreeOfFreedom*>& DOF() const { return _dofList; }

    void listAllDOF(std::vector<DegreeOfFreedom*>& list) const;

    DegreeOfFreedom* DOFById(const FPString& id, const FPString& tag = FPString()) const;

    virtual void dofValueChanged(DegreeOfFreedom& dof) {}

    /*************************************** Hierarchy **********************************/

    const std::vector<FitObject*>& fitObjects() const { return _subobjectList; }

    void registerSubObject(FitObject* subobject, bool deleteOnShutdown = false);

    /*************************************** I/O ****************************************/

    virtual void print(MsgLogger& stream) {
        if(_parent) {
            _parent->print(stream);
            stream << ".";
        }
        stream << id();
        if(tag().empty() == false)
            stream << "[" << tag() << "]";
    }

    virtual void parse(XML::Element element);

    /************************************* Attributes ***********************************/

    bool fitEnabled() const { return _fitEnabled; }

    void setFitEnabled(bool enable) { _fitEnabled = enable; }

    bool outputEnabled() const { return _outputEnabled; }

    void setOutputEnabled(bool enable) { _outputEnabled = enable; }

    const FPString& id() const { return _id; }

    void setId(const FPString& id) { _id = id; }

    const FPString& tag() const { return _tag; }

    void setTag(const FPString& tag) { _tag = tag; }

    FitJob* job() const { return _job; }

    FitObject* parent() const { return _parent; }

protected:

    void registerProperty(FitProperty* prop, bool deleteOnShutdown = false);

    void registerDOF(DegreeOfFreedom* dof);

protected:

    bool _fitEnabled = true;

    bool _outputEnabled = true;

    FitJob* _job = nullptr;

    FPString _id;

    double _relativeWeight = 1.0;

private:

    FPString _tag;

    std::vector<DegreeOfFreedom*> _dofList;

    std::vector<FitProperty*> _fitPropertiesList;

    std::vector<FitObject*> _subobjectList;

    std::vector<std::unique_ptr<FitObject>> _ownedObjects;

    FitObject* _parent = nullptr;

};

} // End of namespace