Compute Graph Framework SDK Reference  5.10
List of all members | Public Member Functions | Protected Attributes
dw::framework::ExceptionSafeProcessNode Class Reference

Detailed Description

Definition at line 40 of file ExceptionSafeNode.hpp.

Inheritance diagram for dw::framework::ExceptionSafeProcessNode:
Inheritance graph
[legend]
Collaboration diagram for dw::framework::ExceptionSafeProcessNode:
Collaboration graph
[legend]

Public Member Functions

 ExceptionSafeProcessNode (std::unique_ptr< Node > impl)
 
dwStatus getErrorSignal (dwGraphErrorSignal *&errorSignal) override
 
dwStatus getHealthSignal (dwGraphHealthSignal *&healthSignal, bool updateFromModule=false) override
 
dwStatus getInputChannel (const uint8_t portID, ChannelObject *&channel) const override
 
dwStatus getInputPort (const uint8_t portID, dw::framework::PortBase *&port) const override
 
dwStatus getName (const char **name) override
 
dwStatus getOutputChannel (const uint8_t portID, ChannelObject *&channel) const override
 
dwStatus getOutputPort (const uint8_t portID, dw::framework::PortBase *&port) const override
 
dwStatus getPass (Pass **pass, uint8_t index) override
 
size_t getPassCount () const noexcept override
 
dwStatus getPasses (VectorFixed< Pass * > &passList) override
 
dwStatus getPasses (VectorFixed< Pass * > &passList, dwProcessorType processorType, dwProcessType processType) override
 
dwStatus reportCurrentErrorSignal (dwGraphErrorSignal &signal) override
 
dwStatus reportCurrentHealthSignal (dwGraphHealthSignal &signal) override
 
dwStatus reset () override
 
void resetPorts () override
 
dwStatus run () override
 
dwStatus runPass (size_t passIndex) override
 
dwStatus setInputChannel (ChannelObject *channel, uint8_t portID) override
 
dwStatus setInputChannel (ChannelObject *channel, uint8_t portID, dwSerializationType dataType) 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, uint8_t portID) override
 
dwStatus setState (const char *state) override
 
dwStatus validate () override
 
 ~ExceptionSafeProcessNode () override=default
 
- Public Member Functions inherited from dw::framework::Node
virtual dwStatus getErrorSignal (dwGraphErrorSignal *&errorSignal)=0
 Get the pointer to the error signal for this node. More...
 
virtual dwStatus getHealthSignal (dwGraphHealthSignal *&healthSignals, bool updateFromModule=false)=0
 Get the pointer to the health signal for this node. More...
 
virtual dwStatus getInputChannel (const uint8_t portID, ChannelObject *&channel) const =0
 Gets the input channel associated with the input port. More...
 
virtual dwStatus getInputPort (const uint8_t portID, dw::framework::PortBase *&port) const =0
 Gets the input port associated with the port id. More...
 
virtual dwStatus getName (const char **name)=0
 Get the name of the node. More...
 
virtual dwStatus getOutputChannel (const uint8_t portID, ChannelObject *&channel) const =0
 Gets the output channel associated with the output port. More...
 
virtual dwStatus getOutputPort (const uint8_t portID, dw::framework::PortBase *&port) const =0
 Gets the output port associated with the port id. More...
 
virtual dwStatus getPass (Pass **pass, uint8_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 getPasses (VectorFixed< Pass * > &passList, dwProcessorType processorType, dwProcessType processType)=0
 Get node passes filtered by processor type and process type. More...
 
virtual dwStatus reportCurrentErrorSignal (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 reportCurrentHealthSignal (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 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, 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 setNodePeriod (uint32_t period)=0
 Set the node's period. More...
 
virtual dwStatus setOutputChannel (ChannelObject *channel, uint8_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 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

- Public Types inherited from dw::framework::Node
using Name_t = FixedString< MAX_NAME_LEN >
 
- Static Public Attributes inherited from dw::framework::Node
static constexpr size_t MAX_NAME_LEN = 128
 
static constexpr uint32_t MAX_PASS_COUNT = 256
 
static constexpr uint32_t MAX_PORT_COUNT = 256
 

Constructor & Destructor Documentation

◆ ExceptionSafeProcessNode()

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

◆ ~ExceptionSafeProcessNode()

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

Member Function Documentation

◆ getErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::getErrorSignal ( dwGraphErrorSignal *&  errorSignal)
overridevirtual

Implements dw::framework::Node.

◆ getHealthSignal()

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

Implements dw::framework::Node.

◆ getInputChannel()

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

Implements dw::framework::Node.

◆ getInputPort()

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

Implements dw::framework::Node.

◆ getName()

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

Implements dw::framework::Node.

◆ getOutputChannel()

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

Implements dw::framework::Node.

◆ getOutputPort()

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

Implements dw::framework::Node.

◆ getPass()

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

Implements dw::framework::Node.

◆ getPassCount()

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

Implements dw::framework::Node.

◆ getPasses() [1/2]

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

Implements dw::framework::Node.

◆ getPasses() [2/2]

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

Implements dw::framework::Node.

◆ reportCurrentErrorSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::reportCurrentErrorSignal ( dwGraphErrorSignal &  signal)
overridevirtual

Implements dw::framework::Node.

◆ reportCurrentHealthSignal()

dwStatus dw::framework::ExceptionSafeProcessNode::reportCurrentHealthSignal ( dwGraphHealthSignal &  signal)
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() [1/2]

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

Implements dw::framework::Node.

◆ setInputChannel() [2/2]

dwStatus dw::framework::ExceptionSafeProcessNode::setInputChannel ( ChannelObject *  channel,
uint8_t  portID,
dwSerializationType  dataType 
)
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,
uint8_t  portID 
)
overridevirtual

Implements dw::framework::Node.

◆ setState()

dwStatus dw::framework::ExceptionSafeProcessNode::setState ( const char *  state)
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 100 of file ExceptionSafeNode.hpp.

Referenced by dw::framework::dwTraceCollectorNode::executeAsyncReset(), dw::framework::dwGlobalEgomotionNode::executeAsyncReset(), dw::framework::dwRelativeEgomotionIMUNode::executeAsyncReset(), dw::framework::dwGlobalEgomotionNode::preShutdown(), dw::framework::dwRelativeEgomotionIMUNode::preShutdown(), dw::framework::dwTraceCollectorNode::setAsyncReset(), dw::framework::dwGlobalEgomotionNode::setAsyncReset(), and dw::framework::dwRelativeEgomotionIMUNode::setAsyncReset().

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