JsonParameterProvider.hpp

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_FRAMEWORK_JSONPARAMETERPROVIDER_HPP_
#define DW_FRAMEWORK_JSONPARAMETERPROVIDER_HPP_
 
#include <dwcgf/parameter/TypeBasedParameterProvider.hpp>
 
#include <modern-json/json.hpp>
 
namespace dw
{
namespace framework
{
 
class JsonParameterProvider : public ITypeBasedParameterProviderChild
{
protected:
    JsonParameterProvider(JsonParameterProvider const&) = default;
    JsonParameterProvider(JsonParameterProvider&&) = default;
    JsonParameterProvider& operator=(JsonParameterProvider const&) & = default;
    JsonParameterProvider& operator=(JsonParameterProvider&&) & = default;
 
public:
    JsonParameterProvider(nlohmann::json const* const data) noexcept;
    ~JsonParameterProvider() override = default;
 
    void setJson(nlohmann::json const* const data) noexcept;
 
    nlohmann::json data() const;
 
    void registerAt(TypeBasedParameterProvider& provider) const override;
 
protected:
    nlohmann::json const* getJson(dw::core::StringView const& key) const;
 
    bool getBool(dw::core::StringView const& key, bool& out) const;
    bool getInt8(dw::core::StringView const& key, int8_t& out) const;
    bool getInt16(dw::core::StringView const& key, int16_t& out) const;
    bool getInt32(dw::core::StringView const& key, int32_t& out) const;
    bool getInt64(dw::core::StringView const& key, int64_t& out) const;
    bool getUint8(dw::core::StringView const& key, uint8_t& out) const;
    bool getUint16(dw::core::StringView const& key, uint16_t& out) const;
    bool getUint32(dw::core::StringView const& key, uint32_t& out) const;
    bool getUint64(dw::core::StringView const& key, uint64_t& out) const;
    bool getFloat32(dw::core::StringView const& key, float32_t& out) const;
    bool getFloat64(dw::core::StringView const& key, float64_t& out) const;
    bool getStringView(dw::core::StringView const& key, dw::core::StringView& out) const;
 
    bool getVectorInt8(dw::core::StringView const& key, std::vector<int8_t>& out) const;
    bool getVectorInt16(dw::core::StringView const& key, std::vector<int16_t>& out) const;
    bool getVectorInt32(dw::core::StringView const& key, std::vector<int32_t>& out) const;
    bool getVectorInt64(dw::core::StringView const& key, std::vector<int64_t>& out) const;
    bool getVectorUint8(dw::core::StringView const& key, std::vector<uint8_t>& out) const;
    bool getVectorUint16(dw::core::StringView const& key, std::vector<uint16_t>& out) const;
    bool getVectorUint32(dw::core::StringView const& key, std::vector<uint32_t>& out) const;
    bool getVectorUint64(dw::core::StringView const& key, std::vector<uint64_t>& out) const;
    bool getVectorFloat32(dw::core::StringView const& key, std::vector<float32_t>& out) const;
    bool getVectorFloat64(dw::core::StringView const& key, std::vector<float64_t>& out) const;
    bool getVectorStringView(dw::core::StringView const& key, std::vector<dw::core::StringView>& out) const;
 
    bool getBoolByIndex(dw::core::StringView const& key, size_t const index, bool& out) const;
    bool getInt8ByIndex(dw::core::StringView const& key, size_t const index, int8_t& out) const;
    bool getInt16ByIndex(dw::core::StringView const& key, size_t const index, int16_t& out) const;
    bool getInt32ByIndex(dw::core::StringView const& key, size_t const index, int32_t& out) const;
    bool getInt64ByIndex(dw::core::StringView const& key, size_t const index, int64_t& out) const;
    bool getUint8ByIndex(dw::core::StringView const& key, size_t const index, uint8_t& out) const;
    bool getUint16ByIndex(dw::core::StringView const& key, size_t const index, uint16_t& out) const;
    bool getUint32ByIndex(dw::core::StringView const& key, size_t const index, uint32_t& out) const;
    bool getUint64ByIndex(dw::core::StringView const& key, size_t const index, uint64_t& out) const;
    bool getFloat32ByIndex(dw::core::StringView const& key, size_t const index, float32_t& out) const;
    bool getFloat64ByIndex(dw::core::StringView const& key, size_t const index, float64_t& out) const;
    bool getStringViewByIndex(dw::core::StringView const& key, size_t const index, dw::core::StringView& out) const;
 
private:
    nlohmann::json const* m_data;
};
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_JSONPARAMETERPROVIDER_HPP_