Configuration.hpp

Go to the documentation of this file.

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once
 
#include "ctre/phoenix/StatusCodes.h"
#include <iosfwd>
#include <string>
 
namespace ctre {
namespace phoenix6 {
namespace configs {
 
/**
 * \brief Common interface for all configuration objects.
 */
class ParentConfiguration {
public:
    virtual std::string ToString() const = 0;
    friend std::ostream &operator<<(std::ostream &str, ParentConfiguration const &v);
 
    /**
     * \brief Serialize this configuration into a string.
     *
     * \returns Serialized configuration
     */
    virtual std::string Serialize() const = 0;
    /**
     * \brief Deserialize this configuration from a string.
     *
     * \param string The serialized configuration
     * \returns Status code of the deserialization
     */
    virtual ctre::phoenix::StatusCode Deserialize(std::string const &string) = 0;
};
 
/**
 * \brief An empty configuration.
 */
class EmptyConfiguration final : public configs::ParentConfiguration {
public:
    constexpr EmptyConfiguration() = default;
 
    std::string ToString() const override
    {
        return "";
    }
    std::string Serialize() const override
    {
        return "";
    }
    ctre::phoenix::StatusCode Deserialize(std::string const &) override
    {
        return ctre::phoenix::StatusCode::OK;
    }
};
 
}
}
}