NodeConcept.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 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_BASE_NODE_NODECONCEPT_HPP_
#define DW_FRAMEWORK_BASE_NODE_NODECONCEPT_HPP_

#error "This file shouldn't be included. It only exists for documentation purpose."

#include <dwcgf/parameter/ParameterProvider.hpp>

#include <memory>

namespace dw
{
namespace framework
{

// forward declaration for the return type of the factory function create()
class NodeT;

class NodeConcept
{
public:
    static std::unique_ptr<NodeT> create(ParameterProvider& provider);

    static constexpr auto describeInputPorts();

    static constexpr auto describeOutputPorts();

    static constexpr auto describeParameters();

    static constexpr auto describePasses();
};

} // namespace framework
} // namespace dw

#endif //DW_FRAMEWORK_BASE_NODE_NODECONCEPT_HPP_