Detailed Description

Definition at line 192 of file Node.hpp.

Inheritance diagram for dw::framework::ProcessNode:

Public Types
using	Name_t = FixedString< MAX_NAME_LEN >

Public Member Functions
virtual dwStatus	getHealthSignals (dwGraphHealthSignalArray *&healthSignals)=0
	Get the pointer to the health signal array for this node. More...

virtual dwStatus	getName (const char **name)=0
	Get the name of the node. More...

virtual size_t	getPassCount () const noexcept=0
	Get number of passes in the node. More...

virtual dwStatus	getPasses (VectorFixed< Pass *> &passList)=0
	Get all the passes in the node. More...

virtual dwStatus	getPasses (VectorFixed< Pass *> &passList, dwProcessorType processorType, dwProcessType processType)=0
	Get node passes filtered by processor type and process type. More...

virtual dwStatus	reset ()=0
	Resets the state of the node. More...

virtual dwStatus	run ()=0
	Runs all the passes in the node. More...

virtual dwStatus	runPass (size_t passIndex)=0
	Run one pass by index as defined by the pass descriptors. More...

virtual dwStatus	runPassByID (uint8_t passID)=0
	Run one pass by ID as defined by the PassList enum class. More...

virtual dwStatus	setInputChannel (ChannelObject *channel, uint8_t portID)=0
	Sets an input channel for this node with an accompanying port. More...

virtual dwStatus	setInputChannel (ChannelObject *channel, uint8_t portID, dwSerializationType dataType)=0
	Sets an input channel for this node with an accompanying port. More...

virtual dwStatus	setIterationCount (uint32_t iterationCount)=0
	Sets the node's iteration count. More...

virtual dwStatus	setName (const char *name)=0
	Set the name of the node. More...

virtual dwStatus	setOutputChannel (ChannelObject *channel, uint8_t portID)=0
	Sets an output channel for this node with an accompanying port. More...

virtual dwStatus	validate ()=0
	Checks that all mandatory ports are bound. More...

	~ProcessNode () override=default

Static Public Attributes
static constexpr size_t	MAX_NAME_LEN = 128

static constexpr uint32_t	MAX_PASS_COUNT = 256

static constexpr uint32_t	MAX_PORT_COUNT = 256

static constexpr uint8_t	PASS_SETUP = std::numeric_limits<uint8_t>::max() - 1

static constexpr uint8_t	PASS_TEARDOWN = std::numeric_limits<uint8_t>::max()

Member Typedef Documentation

◆ Name_t

using dw::framework::Node::Name_t = FixedString<MAX_NAME_LEN>

inherited

Definition at line 67 of file Node.hpp.

Constructor & Destructor Documentation

◆ ~ProcessNode()

dw::framework::ProcessNode::~ProcessNode ( )

overridedefault

Member Function Documentation

◆ getHealthSignals()

virtual dwStatus dw::framework::Node::getHealthSignals ( dwGraphHealthSignalArray *& healthSignals )

pure virtualinherited

Get the pointer to the health signal array for this node.

Parameters

healthSignals The health signal array.

Returns: DW_SUCCESS

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::ExceptionSafeProcessNode, and dw::framework::SimpleNode.

◆ getName()

virtual dwStatus dw::framework::Node::getName ( const char ** name )

pure virtualinherited

Get the name of the node.

Parameters

name	The output name.

Returns: DW_SUCCESS, DW_INVALID_ARUGMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::ExceptionSafeProcessNode, and dw::framework::SimpleNode.

◆ getPassCount()

virtual size_t dw::framework::Node::getPassCount ( ) const

pure virtualnoexceptinherited

Get number of passes in the node.

Returns: The number of passes

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ getPasses() [1/2]

virtual dwStatus dw::framework::Node::getPasses ( VectorFixed< Pass *> & passList )

pure virtualinherited

Get all the passes in the node.

Parameters

passList The output list to populate.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ getPasses() [2/2]

virtual dwStatus dw::framework::Node::getPasses	(	VectorFixed< Pass *> &	passList,
		dwProcessorType	processorType,
		dwProcessType	processType
	)

pure virtualinherited

Get node passes filtered by processor type and process type.

Parameters

passList	The output list to populate.
processorType	Filter by this processor type.
processType	Filter by this process type.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ reset()

virtual dwStatus dw::framework::Node::reset ( )

pure virtualinherited

Resets the state of the node.

Returns: DW_SUCCESS, DW_FAILURE

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::SimpleProcessNodeT< T >, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleSensorNodeT< T >, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ run()

virtual dwStatus dw::framework::Node::run ( )

pure virtualinherited

Runs all the passes in the node.

Returns: DW_SUCCESS, DW_FAILURE

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ runPass()

virtual dwStatus dw::framework::Node::runPass ( size_t passIndex )

pure virtualinherited

Run one pass by index as defined by the pass descriptors.

Parameters

passIndex The index of the pass to run.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT, DW_FAILURE

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ runPassByID()

virtual dwStatus dw::framework::Node::runPassByID ( uint8_t passID )

pure virtualinherited

Run one pass by ID as defined by the PassList enum class.

Parameters

passID The ID of the pass to run.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT, DW_FAILURE

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ setInputChannel() [1/2]

virtual dwStatus dw::framework::Node::setInputChannel	(	ChannelObject *	channel,
		uint8_t	portID
	)

pure virtualinherited

Sets an input channel for this node with an accompanying port.

Parameters

channel	The channel to bind to the portID.
portID	The port to bind the channel with.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ setInputChannel() [2/2]

virtual dwStatus dw::framework::Node::setInputChannel	(	ChannelObject *	channel,
		uint8_t	portID,
		dwSerializationType	dataType
	)

pure virtualinherited

Sets an input channel for this node with an accompanying port.

Parameters

channel	The channel to bind to the portID.
portID	The port to bind the channel with.
dataType	The type of data received by this node from the channel

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ setIterationCount()

virtual dwStatus dw::framework::Node::setIterationCount ( uint32_t iterationCount )

pure virtualinherited

Sets the node's iteration count.

Parameters

iterationCount The current iteration count

Returns: DW_SUCCESS

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::SimpleNode, dw::framework::ExceptionSafeSensorNode, and dw::framework::ExceptionSafeProcessNode.

◆ setName()

virtual dwStatus dw::framework::Node::setName ( const char * name )

pure virtualinherited

Set the name of the node.

Parameters

name	The name of the node.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ setOutputChannel()

virtual dwStatus dw::framework::Node::setOutputChannel	(	ChannelObject *	channel,
		uint8_t	portID
	)

pure virtualinherited

Sets an output channel for this node with an accompanying port.

Parameters

channel	The channel to bind to the portID.
portID	The port to bind the channel with.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

◆ validate()

virtual dwStatus dw::framework::Node::validate ( )

pure virtualinherited

Checks that all mandatory ports are bound.

The implementation should validate that all the ports are bound to the appropriate channels (any required ports, that is). For example, a camera node may have processed output and raw output ports, but only one is required to be bound.

Returns: DW_SUCCESS, DW_FAILURE

Implemented in dw::framework::SimpleProcessNode, dw::framework::SimpleSensorNode, dw::framework::SimpleProcessNodeT< T >, dw::framework::ExceptionSafeSensorNode, dw::framework::SimpleSensorNodeT< T >, dw::framework::SimpleNode, and dw::framework::ExceptionSafeProcessNode.

Field Documentation

◆ MAX_NAME_LEN

constexpr size_t dw::framework::Node::MAX_NAME_LEN = 128

staticinherited

Definition at line 66 of file Node.hpp.

◆ MAX_PASS_COUNT

constexpr uint32_t dw::framework::Node::MAX_PASS_COUNT = 256

staticinherited

Definition at line 71 of file Node.hpp.

◆ MAX_PORT_COUNT

constexpr uint32_t dw::framework::Node::MAX_PORT_COUNT = 256

staticinherited

Definition at line 69 of file Node.hpp.

◆ PASS_SETUP

constexpr uint8_t dw::framework::Node::PASS_SETUP = std::numeric_limits<uint8_t>::max() - 1

staticinherited

Definition at line 72 of file Node.hpp.

◆ PASS_TEARDOWN

constexpr uint8_t dw::framework::Node::PASS_TEARDOWN = std::numeric_limits<uint8_t>::max()

staticinherited

Definition at line 73 of file Node.hpp.

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

src/dwcgf/node/Node.hpp

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ Name_t

Constructor & Destructor Documentation

◆ ~ProcessNode()

Member Function Documentation

◆ getHealthSignals()

◆ getName()

◆ getPassCount()

◆ getPasses() [1/2]

◆ getPasses() [2/2]

◆ reset()

◆ run()

◆ runPass()

◆ runPassByID()

◆ setInputChannel() [1/2]

◆ setInputChannel() [2/2]

◆ setIterationCount()

◆ setName()

◆ setOutputChannel()

◆ validate()

Field Documentation

◆ MAX_NAME_LEN

◆ MAX_PASS_COUNT

◆ MAX_PORT_COUNT

◆ PASS_SETUP

◆ PASS_TEARDOWN