dw::framework::SimpleNodeT< T > Class Template Reference
Detailed Description
template<typename T>
class dw::framework::SimpleNodeT< T >
class dw::framework::SimpleNodeT< T >
Definition at line 109 of file SimpleNodeT.hpp.
Inheritance diagram for dw::framework::SimpleNodeT< T >:
Collaboration diagram for dw::framework::SimpleNodeT< T >:
Public Types | |
| using | NodeT = T |
 Public Types inherited from dw::framework::Node | |
| using | Name_t = FixedString< MAX_NAME_LEN > |
Public Member Functions | |
| std::unique_ptr< Pass > | createSetupPass () override |
| std::unique_ptr< Pass > | createTeardownPass () override |
| dwStatus | reset () override |
| The default implementation calls SimpleNode::resetPorts. More... | |
| virtual dwStatus | setupImpl () |
| The default implementation calls SimpleNode::setup. More... | |
| SimpleNodeT () | |
| Default constructor registering the setup and teardown passes. More... | |
| SimpleNodeT (NodeAllocationParams params) | |
| virtual dwStatus | teardownImpl () |
| The default implementation calls SimpleNode::teardown. More... | |
| dwStatus | validate () override |
| Validate that all registered ports which have the flag binding-required are bound to a channel. More... | |
| Public Member Functions inherited from dw::framework::SimpleNode | |
| void | addPass (Pass *pass) |
| dwStatus | clearErrorSignal () override |
| dwStatus | clearHealthSignal () override |
| dwStatus | copyModuleHealthSignals (dwHealthSignal &outSignal) |
| Copy health signals from the module over to the node and stores in outSignal. More... | |
| dwStatus | getErrorSignal (dwGraphErrorSignal &sehErrorSignal, dwGraphErrorSignal *&errorSignal, uint16_t const sourceId, char8_t const *instanceName=nullptr) override |
| dwStatus | getHealthSignal (dwGraphHealthSignal *&healthSignals, bool updateFromModule=false) override |
| dwStatus | getInputChannel (const uint8_t portID, ChannelObject *&channel) const override |
| Gets the input channel associated with the input port. More... | |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortInput< decltype(portType< NodeT, PortDirection::INPUT, PortIndex >())> & | getInputPort () |
| Get a previously initialized non-array ManagedPortInput. More... | |
| dwStatus | getInputPort (const uint8_t portID, dw::framework::PortBase *&port) const override |
| Gets the input port associated with the input port Id. More... | |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortInput< decltype(portType< NodeT, PortDirection::INPUT, PortIndex >())> & | getInputPort (size_t arrayIndex) |
| Get one specific ManagedPortInput from a previously initialized input array port. More... | |
| uint32_t | getIterationCount () const |
| dwStatus | getName (const char **name) override |
| uint32_t | getNodePeriod () const |
| dwStatus | getOutputChannel (const uint8_t portID, ChannelObject *&channel) const override |
| Gets the output channel associated with the output port. More... | |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortOutput< decltype(portType< NodeT, PortDirection::OUTPUT, PortIndex >())> & | getOutputPort () |
| Get a previously initialized non-array ManagedPortOutput. More... | |
| dwStatus | getOutputPort (const uint8_t portID, dw::framework::PortBase *&port) const override |
| Gets the output port associated with the output port Id. More... | |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortOutput< decltype(portType< NodeT, PortDirection::OUTPUT, PortIndex >())> & | getOutputPort (size_t arrayIndex) |
| Get one specific ManagedPortOutput from a previously initialized output array port. More... | |
| 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) override |
| const dw::core::HeapHashMap< size_t, std::shared_ptr< ManagedPortInputBase > > & | getRegisteredInputPorts () const |
| const dw::core::HeapHashMap< size_t, std::shared_ptr< ManagedPortOutputBase > > & | getRegisteredOutputPorts () const |
| template<typename NodeT , size_t PortIndex, typename... Args> | |
| void | initInputArrayPort (Args &&... args) |
| Initialize an array of ManagedPortInput which will be owned by the base class and can be retrieved using getInputPort(size_t). More... | |
| template<typename NodeT , size_t PortIndex, typename... Args> | |
| void | initInputPort (Args &&... args) |
| Initialize a ManagedPortInput which will be owned by the base class and can be retrieved using getInputPort(). More... | |
| template<typename NodeT , size_t PortIndex, typename... Args> | |
| void | initOutputArrayPort (Args &&... args) |
| Initialize an array of ManagedPortOutput which will be owned by the base class and can be retrieved using getOutputPort(size_t). More... | |
| template<typename NodeT , size_t PortIndex, typename... Args> | |
| void | initOutputPort (Args &&... args) |
| Initialize a ManagedPortOutput which will be owned by the base class and can be retrieved using getOutputPort(). More... | |
| template<typename Func > | |
| void | iterateManagedInputPorts (Func func) |
| template<typename Func > | |
| void | iterateManagedOutputPorts (Func func) |
| template<typename Func , typename PortList > | |
| void | iteratePorts (PortList &portList, Func func) |
| template<typename TPort , typename... Args> | |
| std::unique_ptr< TPort > | make_port (Args &&... args) |
| dwStatus | reset () override |
| void | resetPorts () override |
| Default implementation to reset ports managed by the base class. More... | |
| dwStatus | run () override |
| dwStatus | runPass (size_t passIndex) override |
| dwStatus | setInputChannel (ChannelObject *, uint8_t, dwSerializationType) override |
| dwStatus | setInputChannel (ChannelObject *channel, uint8_t portID) override |
| Associate an input port with a channel instances. More... | |
| dwStatus | setIterationCount (uint32_t iterationCount) override |
| template<typename ModuleHandle_t > | |
| dwStatus | setModuleHandle (ModuleHandle_t handle, dwContextHandle_t context) |
| dwStatus | setName (const char *name) final |
| dwStatus | setNodePeriod (uint32_t period) override |
| virtual dwStatus | setObjectHandle (dwModuleHandle_t handle) |
| dwStatus | setOutputChannel (ChannelObject *channel, uint8_t portID) override |
| Associate an output port with a channel instances. More... | |
| dwStatus | setState (const char *state) override |
| dwStatus | setup () |
| Default implementation of the setup pass. More... | |
| SimpleNode () | |
| SimpleNode (NodeAllocationParams params) | |
| Constructor which tailors the preallocated size of the internal collections for ports and passes to the need of the concrete node. More... | |
| dwStatus | teardown () |
| Default implementation of the teardown pass. More... | |
| dwStatus | updateCurrentErrorSignal (dwGraphErrorSignal &signal) override |
| 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... | |
| dwStatus | updateCurrentHealthSignal (dwGraphHealthSignal &signal) override |
| 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... | |
| dwStatus | updateHealthSignal (const dwGraphHealthSignal &signal) |
| Adds the provided Health Signal to the Health Signal Array. If the array is full, the new signal will not be added. More... | |
| dwStatus | validate () override |
| dwStatus | validate (const char *direction, const PortCollectionDescriptor &collection, dw::core::Function< bool(size_t)> isPortBound) |
| Helper function used by dw::framework::SimpleNodeT::validate. More... | |
| virtual | ~SimpleNode () |
| Public Member Functions inherited from dw::framework::Node | |
| 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 | getErrorSignal (dwGraphErrorSignal &sehErrorSignal, dwGraphErrorSignal *&errorSignal, uint16_t const sourceId, char8_t const *instanceName=nullptr)=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)=0 |
| Get node passes filtered by processor type and process type. 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 | 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 |
Additional Inherited Members | |
| Static Public Attributes inherited from dw::framework::Node | |
| static constexpr const size_t | MAX_NAME_LEN {128U} |
| static constexpr const uint32_t | MAX_PASS_COUNT {256U} |
| static constexpr const uint32_t | MAX_PORT_COUNT {256U} |
| Protected Member Functions inherited from dw::framework::SimpleNode | |
| virtual std::unique_ptr< Pass > | createSetupPass () |
| virtual std::unique_ptr< Pass > | createTeardownPass () |
| dwStatus | getModuleHandle (dwModuleHandle_t *moduleHandle, void *handle, dwContextHandle_t context) |
| template<typename PassFunctionT , typename... Args> | |
| std::unique_ptr< PassImpl< PassFunctionT > > | make_pass (PassFunctionT func, Args &&... args) |
| template<typename NodeT , size_t PassIndex, typename PassFunctionT > | |
| void | registerPass (PassFunctionT func, cudaStream_t const cudaStream, std::initializer_list< std::pair< dwStatus, uint32_t > > const &returnMapping={}) |
| Register a GPU pass function and a cuda stream with the node base class. More... | |
| template<typename NodeT , size_t PassIndex, typename PassFunctionT > | |
| void | registerPass (PassFunctionT func, std::initializer_list< std::pair< dwStatus, uint32_t > > const &returnMapping={}) |
| Register a pass function with the node base class. More... | |
| Protected Attributes inherited from dw::framework::SimpleNode | |
| std::atomic< bool > | m_asyncResetFlag |
| dw::core::HeapHashMap< size_t, std::shared_ptr< ManagedPortInputBase > > | m_inputPorts |
| dw::core::HeapHashMap< size_t, std::shared_ptr< ManagedPortOutputBase > > | m_outputPorts |
Member Typedef Documentation
◆ NodeT
template<typename T >
| using dw::framework::SimpleNodeT< T >::NodeT = T |
Definition at line 113 of file SimpleNodeT.hpp.
Constructor & Destructor Documentation
◆ SimpleNodeT() [1/2]
template<typename T >
|
inline |
Default constructor registering the setup and teardown passes.
Definition at line 116 of file SimpleNodeT.hpp.
◆ SimpleNodeT() [2/2]
template<typename T >
|
inline |
Definition at line 122 of file SimpleNodeT.hpp.
Member Function Documentation
◆ createSetupPass()
template<typename T >
|
inlineoverridevirtual |
- Deprecated:
- When using SimpleProcessNodeT as the base class for a concrete node this methods shouldn't be invoked since the base class provides a default implementation for the setup pass in SimpleProcessNodeT::setupImpl.
Reimplemented from dw::framework::SimpleNode.
Definition at line 130 of file SimpleNodeT.hpp.
◆ createTeardownPass()
template<typename T >
|
inlineoverridevirtual |
- Deprecated:
- When using SimpleProcessNodeT as the base class for a concrete node this methods shouldn't be invoked since the base class provides a default implementation for the setup pass in SimpleProcessNodeT::teardownImpl.
Reimplemented from dw::framework::SimpleNode.
Definition at line 137 of file SimpleNodeT.hpp.
◆ reset()
template<typename T >
|
inlineoverridevirtual |
The default implementation calls SimpleNode::resetPorts.
Reimplemented from dw::framework::SimpleNode.
Definition at line 155 of file SimpleNodeT.hpp.
References dw::framework::SimpleNode::resetPorts().
◆ setupImpl()
template<typename T >
|
inlinevirtual |
The default implementation calls SimpleNode::setup.
Definition at line 143 of file SimpleNodeT.hpp.
References dw::framework::SimpleNode::setup().
◆ teardownImpl()
template<typename T >
|
inlinevirtual |
The default implementation calls SimpleNode::teardown.
Definition at line 149 of file SimpleNodeT.hpp.
References dw::framework::SimpleNode::teardown().
◆ validate()
template<typename T >
|
inlineoverridevirtual |
Validate that all registered ports which have the flag binding-required are bound to a channel.
Reimplemented from dw::framework::SimpleNode.
Definition at line 162 of file SimpleNodeT.hpp.
References dw::framework::PortCollectionDescriptor::getPortSize(), dw::framework::SimpleNode::getRegisteredInputPorts(), dw::framework::SimpleNode::getRegisteredOutputPorts(), and dw::framework::SimpleNode::validate().
The documentation for this class was generated from the following file:
- src/dwcgf/core/dwcgf/node/SimpleNodeT.hpp
