dw::framework::SimpleProcessNodeT< T > Class Template Reference
Detailed Description
template<typename T>
class dw::framework::SimpleProcessNodeT< T >
class dw::framework::SimpleProcessNodeT< T >
- Deprecated:
- Use SimpleNodeT<T> instead.
Definition at line 196 of file SimpleNodeT.hpp.
Inheritance diagram for dw::framework::SimpleProcessNodeT< T >:
Collaboration diagram for dw::framework::SimpleProcessNodeT< T >:
Additional Inherited Members | |
 Public Types inherited from dw::framework::SimpleNodeT< T > | |
| using | NodeT = T |
| Public Types inherited from dw::framework::Node | |
| using | Name_t = FixedString< MAX_NAME_LEN > |
| Public Member Functions inherited from dw::framework::SimpleNodeT< T > | |
| 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 | clearHealthSignal () |
| Clears the current Health Signals from the Health Signal Array. More... | |
| dwStatus | copyModuleHealthSignals (dwHealthSignal &outSignal) |
| Copy health signals from the module over to the node and stores in outSignal. More... | |
| dwStatus | getErrorSignal (dwGraphErrorSignal *&errorSignal) override |
| dwStatus | getHealthSignal (dwGraphHealthSignal *&healthSignals, bool updateFromModule=false) override |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortInput< decltype(portType< NodeT, PortDirection::INPUT, PortIndex >())> & | getInputPort () |
| Get a previously initialized non-array ManagedPortInput. 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 |
| template<typename NodeT , size_t PortIndex> | |
| ManagedPortOutput< decltype(portType< NodeT, PortDirection::OUTPUT, PortIndex >())> & | getOutputPort () |
| Get a previously initialized non-array ManagedPortOutput. 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... | |
| size_t | getPassCount () const noexcept override |
| dwStatus | getPasses (VectorFixed< Pass * > &passList) override |
| dwStatus | getPasses (VectorFixed< Pass * > &passList, dwProcessorType processorType, dwProcessType processType) override |
| const dw::core::HeapHashMap< size_t, std::shared_ptr< PortBase > > & | getRegisteredInputPorts () const |
| const dw::core::HeapHashMap< size_t, std::shared_ptr< PortBase > > & | 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 | reportCurrentErrorSignal (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 | reportCurrentHealthSignal (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 | 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 | runPassByID (uint8_t passID) 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 |
| 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 | 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, const dw::core::HeapHashMap< size_t, std::shared_ptr< PortBase > > &ports, size_t indexOffset=0) |
| Helper function used by dw::framework::SimpleNodeT::validate. More... | |
| virtual | ~SimpleNode () |
| 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 | 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 | 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 | 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 | 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 |
| Static Public Attributes inherited from dw::framework::SimpleNode | |
| static constexpr const char * | PASS_SETUP_NAME = "SETUP" |
| static constexpr const char * | PASS_TEARDOWN_NAME = "TEARDOWN" |
| 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 |
| 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 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, NvMediaDla *dlaEngine=nullptr) |
| Register a pass function with the node base class. More... | |
| Protected Attributes inherited from dw::framework::SimpleNode | |
| std::atomic< bool > | m_asyncResetFlag {false} |
| dw::core::HeapHashMap< size_t, std::shared_ptr< PortBase > > | m_inputPorts |
| dw::core::HeapHashMap< size_t, std::shared_ptr< PortBase > > | m_outputPorts |
The documentation for this class was generated from the following file:
- src/dwcgf/node/SimpleNodeT.hpp
