Compute Graph Framework SDK Reference  5.8
NodeConcept.hpp
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
31#ifndef DW_FRAMEWORK_BASE_NODE_NODECONCEPT_HPP_
32#define DW_FRAMEWORK_BASE_NODE_NODECONCEPT_HPP_
33
34#error "This file shouldn't be included. It only exists for documentation purpose."
35
37
38#include <memory>
39
40namespace dw
41{
42namespace framework
43{
44
45// forward declaration for the return type of the factory function create()
46class NodeT;
47
54{
55public:
64 static std::unique_ptr<NodeT> create(ParameterProvider& provider);
65
71 static constexpr auto describeInputPorts();
72
78 static constexpr auto describeOutputPorts();
79
85 static constexpr auto describeParameters();
86
92 static constexpr auto describePasses();
93};
94
95} // namespace framework
96} // namespace dw
97
98#endif //DW_FRAMEWORK_BASE_NODE_NODECONCEPT_HPP_
The class only exists for documentation.
Definition: NodeConcept.hpp:54
static std::unique_ptr< NodeT > create(ParameterProvider &provider)
Create an instance of the node.
static constexpr auto describeOutputPorts()
Describe the output ports of the node.
static constexpr auto describeParameters()
Describe the parameters of the node and their mapping to the constructor arguments.
static constexpr auto describePasses()
Describe the passes of the node.
static constexpr auto describeInputPorts()
Describe the input ports of the node.
The interface to access parameter values identified by name and/or (semantic) type.
Definition: Exception.hpp:47