abstractbeammodifier.h

#ifndef CTL_ABSTRACTBEAMMODIFIER_H
#define CTL_ABSTRACTBEAMMODIFIER_H

#include "systemcomponent.h"
#include "models/intervaldataseries.h"

/*
 * NOTE: This is header only.
 */

namespace CTL {

// future releases: spatial dependency
// * To describe angular dependency of the modification, angles \a theta and \a phi can be
// * passed as optional parameters. These stick to the conventional angle definitions in spherical
// * coordinates (\a phi - azimuthal angle, \a theta - polar angle).

class AbstractBeamModifier : public SystemComponent
{
    CTL_TYPE_ID(400)
    DECLARE_ELEMENTAL_TYPE

    // abstract interface
    public:virtual IntervalDataSeries modifiedSpectrum(const IntervalDataSeries& inputSpectrum) = 0;
    public:virtual double modifiedFlux(double inputFlux,
                                       const IntervalDataSeries& inputSpectrum) = 0;

public:
    // virtual methods
    QString info() const override;

    void fromVariant(const QVariant& variant) override; // de-serialization
    QVariant toVariant() const override; // serialization

    ~AbstractBeamModifier() override = default;

protected:
    AbstractBeamModifier() = default;
    AbstractBeamModifier(const QString& name);

    AbstractBeamModifier(const AbstractBeamModifier&) = default;
    AbstractBeamModifier(AbstractBeamModifier&&) = default;
    AbstractBeamModifier& operator=(const AbstractBeamModifier&) = default;
    AbstractBeamModifier& operator=(AbstractBeamModifier&&) = default;
};

inline AbstractBeamModifier::AbstractBeamModifier(const QString& name)
    : SystemComponent(name)
{
}

inline QString AbstractBeamModifier::info() const
{
    QString ret(SystemComponent::info());

    ret += typeInfoString(typeid(this));
    ret += (this->type() == AbstractBeamModifier::Type) ? QLatin1String("}\n") : QLatin1String("");

    return ret;
}

// Use SerializationInterface::fromVariant() documentation.
inline void AbstractBeamModifier::fromVariant(const QVariant& variant)
{
    SystemComponent::fromVariant(variant);
}

// Use SerializationInterface::toVariant() documentation.
inline QVariant AbstractBeamModifier::toVariant() const
{
    return SystemComponent::toVariant();
}

} // namespace CTL

#endif // CTL_ABSTRACTBEAMMODIFIER_H