dw::framework::NodeConcept Class Reference

Detailed Description

The class only exists for documentation.

A node registered at the node factory with DW_REGISTER_NODE() must have the static functions declared in this class.

Definition at line 53 of file NodeConcept.hpp.

Static Public Member Functions
static std::unique_ptr< NodeT >	create (ParameterProvider &provider)
	Create an instance of the node. More...
static constexpr auto	describeInputPorts ()
	Describe the input ports of the node. More...
static constexpr auto	describeOutputPorts ()
	Describe the output ports of the node. More...
static constexpr auto	describeParameters ()
	Describe the parameters of the node and their mapping to the constructor arguments. More...
static constexpr auto	describePasses ()
	Describe the passes of the node. More...

Member Function Documentation

create()

static std::unique_ptr< NodeT > dw::framework::NodeConcept::create ( ParameterProvider &  provider )

static

Create an instance of the node.

Constructor arguments are being populated with parameters values as declared and mapped by declareParameters().

Parameters

provider

to retrieve parameter values from

Returns

a unique pointer to the newly created node instance, NodeT should be substituted with the class name this function is defined in

describeInputPorts()

static constexpr auto dw::framework::NodeConcept::describeInputPorts ( )

staticconstexpr

Describe the input ports of the node.

Returns

A tuple created by describePortCollection()

describeOutputPorts()

static constexpr auto dw::framework::NodeConcept::describeOutputPorts ( )

staticconstexpr

Describe the output ports of the node.

Returns

A tuple created by describePortCollection()

describeParameters()

static constexpr auto dw::framework::NodeConcept::describeParameters ( )

staticconstexpr

Describe the parameters of the node and their mapping to the constructor arguments.

Returns

A tuple created by describeConstructorArguments()

describePasses()

static constexpr auto dw::framework::NodeConcept::describePasses ( )

staticconstexpr

Describe the passes of the node.

Returns

A tuple created by describePassCollection()

---

The documentation for this class was generated from the following file:

• src/dwcgf/node/NodeConcept.hpp