Compute Graph Framework SDK Reference
5.4.5418 Release
For Test and Development only

dw::framework::ExceptionSafeProcessNode Class Reference

Detailed Description

Definition at line 40 of file ExceptionSafeNode.hpp.

Inheritance diagram for dw::framework::ExceptionSafeProcessNode:
dw::framework::ProcessNode dw::framework::Node

Public Types

using Name_t = FixedString< MAX_NAME_LEN >
 

Public Member Functions

 ExceptionSafeProcessNode (std::unique_ptr< ProcessNode > impl)
 
dwStatus getHealthSignals (dwGraphHealthSignalArray *&healthSignals) override
 
dwStatus getName (const char **name) override
 
size_t getPassCount () const noexcept override
 
dwStatus getPasses (VectorFixed< Pass *> &passList) override
 
dwStatus getPasses (VectorFixed< Pass *> &passList, dwProcessorType processorType, dwProcessType processType) override
 
dwStatus reset () override
 
dwStatus run () override
 
dwStatus runPass (size_t passIndex) override
 
dwStatus runPassByID (uint8_t passID) 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 setOutputChannel (ChannelObject *channel, uint8_t portID) override
 
dwStatus validate () override
 
 ~ExceptionSafeProcessNode () 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()
 

Protected Attributes

std::unique_ptr< ProcessNodem_impl
 

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

◆ ExceptionSafeProcessNode()

dw::framework::ExceptionSafeProcessNode::ExceptionSafeProcessNode ( std::unique_ptr< ProcessNode impl)
inlineexplicit

Definition at line 43 of file ExceptionSafeNode.hpp.

References ~ExceptionSafeProcessNode().

◆ ~ExceptionSafeProcessNode()

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

Member Function Documentation

◆ getHealthSignals()

dwStatus dw::framework::ExceptionSafeProcessNode::getHealthSignals ( dwGraphHealthSignalArray *&  healthSignals)
inlineoverridevirtual

Implements dw::framework::Node.

Definition at line 141 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ getName()

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

Implements dw::framework::Node.

Definition at line 134 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ getPassCount()

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

Implements dw::framework::Node.

Definition at line 92 of file ExceptionSafeNode.hpp.

References m_impl.

◆ getPasses() [1/2]

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

Implements dw::framework::Node.

Definition at line 111 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ getPasses() [2/2]

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

Implements dw::framework::Node.

Definition at line 118 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ reset()

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

Implements dw::framework::Node.

Definition at line 50 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ run()

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

Implements dw::framework::Node.

Definition at line 85 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ runPass()

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

Implements dw::framework::Node.

Definition at line 104 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ runPassByID()

dwStatus dw::framework::ExceptionSafeProcessNode::runPassByID ( uint8_t  passID)
inlineoverridevirtual

Implements dw::framework::Node.

Definition at line 97 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ setInputChannel() [1/2]

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

Implements dw::framework::Node.

Definition at line 57 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ setInputChannel() [2/2]

dwStatus dw::framework::ExceptionSafeProcessNode::setInputChannel ( ChannelObject channel,
uint8_t  portID,
dwSerializationType  dataType 
)
inlineoverridevirtual

Implements dw::framework::Node.

Definition at line 64 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ setIterationCount()

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

Implements dw::framework::Node.

Definition at line 148 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ setName()

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

Implements dw::framework::Node.

Definition at line 127 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ setOutputChannel()

dwStatus dw::framework::ExceptionSafeProcessNode::setOutputChannel ( ChannelObject channel,
uint8_t  portID 
)
inlineoverridevirtual

Implements dw::framework::Node.

Definition at line 71 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

◆ validate()

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

Implements dw::framework::Node.

Definition at line 78 of file ExceptionSafeNode.hpp.

References dw::framework::Exception::guardWithReturn(), and m_impl.

Field Documentation

◆ m_impl

std::unique_ptr<ProcessNode> dw::framework::ExceptionSafeProcessNode::m_impl
protected

◆ 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: