Detailed Description

Definition at line 41 of file ExceptionSafeNode.hpp.

Inheritance diagram for dw::framework::ExceptionSafeProcessNode:

[legend]

Collaboration diagram for dw::framework::ExceptionSafeProcessNode:

Public Member Functions
dwStatus	addToErrorSignal (uint32_t error, dwTime_t timestamp=0L) override

dwStatus	addToHealthSignal (uint32_t error, dwTime_t timestamp=0L) override

dwStatus	clearErrorSignal () override

dwStatus	clearHealthSignal () override

dwStatus	collectErrorSignals (dwGraphErrorSignal *&errorSignal, bool updateFromModule=true) override

dwStatus	collectHealthSignals (dwGraphHealthSignal *&healthSignal, bool updateFromModule=false) override

	ExceptionSafeProcessNode (std::unique_ptr< Node > impl)

dwStatus	getInputChannel (const size_t portID, ChannelObject *&channel) const override

dwStatus	getInputPort (const size_t portID, dw::framework::PortBase *&port) const override

dwStatus	getModuleErrorSignal (dwErrorSignal &errorSignal) override

dwStatus	getModuleHealthSignal (dwHealthSignal &healthSignal) override

dwStatus	getName (const char **name) override

dwStatus	getNodeErrorSignal (dwGraphErrorSignal &errorSignal) override

dwStatus	getNodeHealthSignal (dwGraphHealthSignal &healthSignal) override

dwStatus	getOutputChannel (const size_t portID, ChannelObject *&channel) const override

dwStatus	getOutputPort (const size_t portID, dw::framework::PortBase *&port) const override

dwStatus	getPass (Pass **pass, size_t index) override

size_t	getPassCount () const noexcept override

dwStatus	getPasses (VectorFixed< Pass * > &passList) override

dwStatus	reset () override

void	resetPorts () override

dwStatus	run () override

dwStatus	runPass (size_t passIndex) override

dwStatus	setInputChannel (ChannelObject *channel, size_t portID) override

dwStatus	setIterationCount (uint32_t iterationCount) override final

dwStatus	setName (const char *name) override

dwStatus	setNodePeriod (uint32_t period) override final

dwStatus	setOutputChannel (ChannelObject *channel, size_t portID) override

dwStatus	setState (const char *state) override

dwStatus	updateCurrentErrorSignal (dwGraphErrorSignal &signal) override

dwStatus	updateCurrentHealthSignal (dwGraphHealthSignal &signal) override

dwStatus	validate () override

	~ExceptionSafeProcessNode () override=default

Public Member Functions inherited from dw::framework::Node
virtual dwStatus	addToErrorSignal (uint32_t error, dwTime_t timestamp=0L)=0
	A function the allows user to add an error to the error signal list. More...

virtual dwStatus	addToHealthSignal (uint32_t error, dwTime_t timestamp=0L)=0
	A function the allows user to add an error to the health signal list. More...

virtual dwStatus	clearErrorSignal ()=0
	Clear the error signal for this node. More...

virtual dwStatus	clearHealthSignal ()=0
	Clear the health signal for this node. More...

virtual dwStatus	collectErrorSignals (dwGraphErrorSignal *&errorSignal, bool updateFromModule=true)=0
	Collect error signals from node and module, combine and return the pointer to the error signal for this node. If combination of module and node signals exceeds max amount, will return up to max amount, node first, and DW_BUFFER_FULL. More...

virtual dwStatus	collectHealthSignals (dwGraphHealthSignal *&healthSignal, bool updateFromModule=false)=0
	Collect health signals from node and module, combine and return the pointer to the health signal for this node. If combination of module and node signals exceeds max amount, will return up to max amount, node first, and DW_BUFFER_FULL. More...

virtual dwStatus	getInputChannel (const size_t portID, ChannelObject *&channel) const =0
	Gets the input channel associated with the input port. More...

virtual dwStatus	getInputPort (const size_t portID, dw::framework::PortBase *&port) const =0
	Gets the input port associated with the port id. More...

virtual dwStatus	getModuleErrorSignal (dwErrorSignal &errorSignal)=0
	Get a copy of the error signals from the module that is a member of this node. More...

virtual dwStatus	getModuleHealthSignal (dwHealthSignal &healthSignal)=0
	Return a copy of health signals from module that is a member of node. More...

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

virtual dwStatus	getNodeErrorSignal (dwGraphErrorSignal &errorSignal)=0
	Get a copy of the error signals for the node. More...

virtual dwStatus	getNodeHealthSignal (dwGraphHealthSignal &healthSignal)=0
	Return a copy of graph health signals for the node. More...

virtual dwStatus	getOutputChannel (const size_t portID, ChannelObject *&channel) const =0
	Gets the output channel associated with the output port. More...

virtual dwStatus	getOutputPort (const size_t portID, dw::framework::PortBase *&port) const =0
	Gets the output port associated with the port id. More...

virtual dwStatus	getPass (Pass **pass, size_t index)=0
	Get a const pointer to the pass at a specific index. 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	reset ()=0
	Resets the state of the node. More...

virtual void	resetPorts ()=0
	Resets all the ports in 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	setInputChannel (ChannelObject *channel, size_t portID)=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	setNodePeriod (uint32_t period)=0
	Set the node's period. More...

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

virtual dwStatus	setState (const char *state)=0
	Set the current state in node. Node implementation of this API need to be thread-safe. More...

virtual dwStatus	updateCurrentErrorSignal (dwGraphErrorSignal &signal)=0
	A function that allows user override to update error signal It is automatically called by dwFramework when getErrorSignal is called and when pass returns non-success return code. More...

virtual dwStatus	updateCurrentHealthSignal (dwGraphHealthSignal &signal)=0
	A function that allows user override to update health signal It is automatically called by dwFramework during teardown and when pass returns non-success return code. More...

virtual dwStatus	validate ()=0
	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. More...

virtual	~Node ()=default

Protected Attributes
std::unique_ptr< Node >	m_impl

Additional Inherited Members
Static Public Attributes inherited from dw::framework::Node
static constexpr const size_t	MAX_NAME_LEN {128U}

Constructor & Destructor Documentation

◆ ExceptionSafeProcessNode()

dw::framework::ExceptionSafeProcessNode::ExceptionSafeProcessNode ( std::unique_ptr< Node > impl )

explicit

◆ ~ExceptionSafeProcessNode()

dw::framework::ExceptionSafeProcessNode::~ExceptionSafeProcessNode ( )

overridedefault

Member Function Documentation

◆ addToErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::addToErrorSignal	(	uint32_t	error,
		dwTime_t	timestamp = `0L`
	)

overridevirtual

Implements dw::framework::Node.

◆ addToHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::addToHealthSignal	(	uint32_t	error,
		dwTime_t	timestamp = `0L`
	)

overridevirtual

Implements dw::framework::Node.

◆ clearErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::clearErrorSignal ( )

overridevirtual

Implements dw::framework::Node.

◆ clearHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::clearHealthSignal ( )

overridevirtual

Implements dw::framework::Node.

◆ collectErrorSignals()

dwStatus dw::framework::ExceptionSafeProcessNode::collectErrorSignals	(	dwGraphErrorSignal *&	errorSignal,
		bool	updateFromModule = `true`
	)

overridevirtual

Implements dw::framework::Node.

◆ collectHealthSignals()

dwStatus dw::framework::ExceptionSafeProcessNode::collectHealthSignals	(	dwGraphHealthSignal *&	healthSignal,
		bool	updateFromModule = `false`
	)

overridevirtual

Implements dw::framework::Node.

◆ getInputChannel()

dwStatus dw::framework::ExceptionSafeProcessNode::getInputChannel	(	const size_t	portID,
		ChannelObject *&	channel
	)		const

overridevirtual

Implements dw::framework::Node.

◆ getInputPort()

dwStatus dw::framework::ExceptionSafeProcessNode::getInputPort	(	const size_t	portID,
		dw::framework::PortBase *&	port
	)		const

overridevirtual

Implements dw::framework::Node.

◆ getModuleErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::getModuleErrorSignal ( dwErrorSignal & errorSignal )

overridevirtual

Implements dw::framework::Node.

◆ getModuleHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::getModuleHealthSignal ( dwHealthSignal & healthSignal )

overridevirtual

Implements dw::framework::Node.

◆ getName()

dwStatus dw::framework::ExceptionSafeProcessNode::getName ( const char ** name )

overridevirtual

Implements dw::framework::Node.

◆ getNodeErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::getNodeErrorSignal ( dwGraphErrorSignal & errorSignal )

overridevirtual

Implements dw::framework::Node.

◆ getNodeHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::getNodeHealthSignal ( dwGraphHealthSignal & healthSignal )

overridevirtual

Implements dw::framework::Node.

◆ getOutputChannel()

dwStatus dw::framework::ExceptionSafeProcessNode::getOutputChannel	(	const size_t	portID,
		ChannelObject *&	channel
	)		const

overridevirtual

Implements dw::framework::Node.

◆ getOutputPort()

dwStatus dw::framework::ExceptionSafeProcessNode::getOutputPort	(	const size_t	portID,
		dw::framework::PortBase *&	port
	)		const

overridevirtual

Implements dw::framework::Node.

◆ getPass()

dwStatus dw::framework::ExceptionSafeProcessNode::getPass	(	Pass **	pass,
		size_t	index
	)

overridevirtual

Implements dw::framework::Node.

◆ getPassCount()

size_t dw::framework::ExceptionSafeProcessNode::getPassCount ( ) const

overridevirtualnoexcept

Implements dw::framework::Node.

◆ getPasses()

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

overridevirtual

Implements dw::framework::Node.

◆ reset()

dwStatus dw::framework::ExceptionSafeProcessNode::reset ( )

overridevirtual

Implements dw::framework::Node.

◆ resetPorts()

void dw::framework::ExceptionSafeProcessNode::resetPorts ( )

overridevirtual

Implements dw::framework::Node.

◆ run()

dwStatus dw::framework::ExceptionSafeProcessNode::run ( )

overridevirtual

Implements dw::framework::Node.

◆ runPass()

dwStatus dw::framework::ExceptionSafeProcessNode::runPass ( size_t passIndex )

overridevirtual

Implements dw::framework::Node.

◆ setInputChannel()

dwStatus dw::framework::ExceptionSafeProcessNode::setInputChannel	(	ChannelObject *	channel,
		size_t	portID
	)

overridevirtual

Implements dw::framework::Node.

◆ setIterationCount()

dwStatus dw::framework::ExceptionSafeProcessNode::setIterationCount ( uint32_t iterationCount )

finaloverridevirtual

Implements dw::framework::Node.

◆ setName()

dwStatus dw::framework::ExceptionSafeProcessNode::setName ( const char * name )

overridevirtual

Implements dw::framework::Node.

◆ setNodePeriod()

dwStatus dw::framework::ExceptionSafeProcessNode::setNodePeriod ( uint32_t period )

finaloverridevirtual

Implements dw::framework::Node.

◆ setOutputChannel()

dwStatus dw::framework::ExceptionSafeProcessNode::setOutputChannel	(	ChannelObject *	channel,
		size_t	portID
	)

overridevirtual

Implements dw::framework::Node.

◆ setState()

dwStatus dw::framework::ExceptionSafeProcessNode::setState ( const char * state )

overridevirtual

Implements dw::framework::Node.

◆ updateCurrentErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::updateCurrentErrorSignal ( dwGraphErrorSignal & signal )

overridevirtual

Implements dw::framework::Node.

◆ updateCurrentHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::updateCurrentHealthSignal ( dwGraphHealthSignal & signal )

overridevirtual

Implements dw::framework::Node.

◆ validate()

dwStatus dw::framework::ExceptionSafeProcessNode::validate ( )

overridevirtual

Implements dw::framework::Node.

Member Data Documentation

◆ m_impl

std::unique_ptr<Node> dw::framework::ExceptionSafeProcessNode::m_impl

protected

Definition at line 114 of file ExceptionSafeNode.hpp.

Referenced by dw::framework::dwGlobalEgomotionNode::preShutdown(), and dw::framework::dwRelativeEgomotionNode::preShutdown().

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

src/dwcgf/core/dwcgf/node/impl/ExceptionSafeNode.hpp

Detailed Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ExceptionSafeProcessNode()

◆ ~ExceptionSafeProcessNode()

Member Function Documentation

◆ addToErrorSignal()

◆ addToHealthSignal()

◆ clearErrorSignal()

◆ clearHealthSignal()

◆ collectErrorSignals()

◆ collectHealthSignals()

◆ getInputChannel()

◆ getInputPort()

◆ getModuleErrorSignal()

◆ getModuleHealthSignal()

◆ getName()

◆ getNodeErrorSignal()

◆ getNodeHealthSignal()

◆ getOutputChannel()

◆ getOutputPort()

◆ getPass()

◆ getPassCount()

◆ getPasses()

◆ reset()

◆ resetPorts()

◆ run()

◆ runPass()

◆ setInputChannel()

◆ setIterationCount()

◆ setName()

◆ setNodePeriod()

◆ setOutputChannel()

◆ setState()

◆ updateCurrentErrorSignal()

◆ updateCurrentHealthSignal()

◆ validate()

Member Data Documentation

◆ m_impl