cafFieldValidator.h

// ##################################################################################################
//
//    Custom Visualization Core library
//    Copyright (C) 2021- 3D-Radar AS
//
//    This library may be used under the terms of the GNU Lesser General Public License as follows:
//
//    GNU Lesser General Public License Usage
//    This library is free software; you can redistribute it and/or modify
//    it under the terms of the GNU Lesser General Public License as published by
//    the Free Software Foundation; either version 2.1 of the License, or
//    (at your option) any later version.
//
//    This library 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 Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//    for more details.
//
// ##################################################################################################
#pragma once

#include <string>
#include <utility>

namespace caffa
{

class FieldValidatorInterface
{
public:
    enum class FailureSeverity
    {
        VALIDATOR_WARNING,
        VALIDATOR_ERROR,
        VALIDATOR_CRITICAL
    };

    FieldValidatorInterface( FailureSeverity failureSeverity )
        : m_failureSeverity( failureSeverity )
    {
    }

    virtual ~FieldValidatorInterface() = default;
    virtual void readFromString( const std::string& string ) = 0;

    virtual std::string writeToString() const = 0;

    FailureSeverity failureSeverity() const { return m_failureSeverity; }

private:
    FailureSeverity m_failureSeverity;
};

template <typename DataType>
class FieldValidator : public FieldValidatorInterface
{
public:
    using FailureSeverity = FieldValidatorInterface::FailureSeverity;

    FieldValidator( FailureSeverity failureSeverity = FailureSeverity::VALIDATOR_ERROR )
        : FieldValidatorInterface( failureSeverity )
    {
    }

    virtual std::pair<bool, std::string> validate( const DataType& value ) const = 0;
};

} // namespace caffa