List of all members |
Public Member Functions |
Static Public Member Functions |
Static Public Attributes
dw::framework::dwLidarNode Class Reference
Detailed Description
Definition at line 54 of file dwLidarNode.hpp.
Inheritance diagram for dw::framework::dwLidarNode:
Collaboration diagram for dw::framework::dwLidarNode:
Public Member Functions | |
| dwLidarNode (const char *sensorName, dwConstRigHandle_t rigHandle, dwSALHandle_t sal, dwContextHandle_t ctx) | |
| dwLidarNode (const dwSensorParams ¶ms, dwSALHandle_t sal, dwContextHandle_t ctx) | |
| dwSensorType | getSensorType () const |
 Public Member Functions inherited from dw::framework::ExceptionSafeSensorNode | |
| ExceptionSafeSensorNode (std::unique_ptr< Node > impl) | |
| dwStatus | getErrorSignal (dwGraphErrorSignal *&errorSignal) override |
| dwStatus | getHealthSignal (dwGraphHealthSignal *&healthSignal, bool updateFromModule=false) 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 | isVirtual (bool *isVirtualBool) 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 | runPassByID (uint8_t passID) override |
| dwStatus | setAffinityMask (uint mask) override |
| dwStatus | setDataEventReadCallback (DataEventReadCallback cb) override |
| dwStatus | setDataEventWriteCallback (DataEventWriteCallback cb) override |
| dwStatus | setEndTime (dwTime_t endTime) 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 | setStartTime (dwTime_t startTime) override |
| dwStatus | setState (const char *state) override |
| dwStatus | setThreadPriority (int prio) override |
| dwStatus | start () override |
| dwStatus | stop () override |
| dwStatus | validate () override |
| ~ExceptionSafeSensorNode () 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 | 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 |
| virtual dwStatus | isVirtual (bool *isVirtualBool)=0 |
| distinguishes between a live and virtual sensor More... | |
| virtual dwStatus | setAffinityMask (uint)=0 |
| Sets the affinity mask of the sensor. More... | |
| virtual dwStatus | setDataEventReadCallback (DataEventReadCallback cb)=0 |
| Set read timestamp function for dataset replay. Timestamps not in the sequence returned by the callback will be dropped. More... | |
| virtual dwStatus | setDataEventWriteCallback (DataEventWriteCallback cb)=0 |
| Set write timestamp function for live case. Each timestamp of data output from the node will be passed to this callback. More... | |
| virtual dwStatus | setEndTime (dwTime_t)=0 |
| Set end timestamp for dataset replay. More... | |
| virtual dwStatus | setStartTime (dwTime_t)=0 |
| Set start timestamp for dataset replay. More... | |
| virtual dwStatus | setThreadPriority (int)=0 |
| Sets the thread priority of the sensor. More... | |
| virtual dwStatus | start ()=0 |
| Start the sensor. More... | |
| virtual dwStatus | stop ()=0 |
| Stop the sensor. More... | |
Static Public Member Functions | |
| static std::unique_ptr< dwLidarNode > | create (ParameterProvider &provider) |
| static constexpr auto | describeInputPorts () |
| static constexpr auto | describeOutputPorts () |
| static constexpr auto | describeParameters () |
| static constexpr auto | describePasses () |
Static Public Attributes | |
| static constexpr char | LOG_TAG [] = "dwLidarNode" |
| 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() |
Additional Inherited Members | |
| Public Types inherited from dw::framework::Node | |
| using | Name_t = FixedString< MAX_NAME_LEN > |
| Public Types inherited from dw::framework::ISensorNode | |
| using | DataEventReadCallback = dw::core::Function< bool(DataEvent &)> |
| enum class | DataEventType { PRODUCE , DROP , NONE } |
| using | DataEventWriteCallback = dw::core::Function< void(DataEvent)> |
| Protected Attributes inherited from dw::framework::ExceptionSafeSensorNode | |
| std::unique_ptr< Node > | m_impl |
| ISensorNode * | m_sensorNodeImpl |
Constructor & Destructor Documentation
◆ dwLidarNode() [1/2]
| dw::framework::dwLidarNode::dwLidarNode | ( | const char * | sensorName, |
| dwConstRigHandle_t | rigHandle, | ||
| dwSALHandle_t | sal, | ||
| dwContextHandle_t | ctx | ||
| ) |
◆ dwLidarNode() [2/2]
| dw::framework::dwLidarNode::dwLidarNode | ( | const dwSensorParams & | params, |
| dwSALHandle_t | sal, | ||
| dwContextHandle_t | ctx | ||
| ) |
Member Function Documentation
◆ create()
|
static |
◆ describeInputPorts()
|
inlinestaticconstexpr |
Definition at line 59 of file dwLidarNode.hpp.
References dw::framework::describePortCollection(), and DW_DESCRIBE_PORT.
◆ describeOutputPorts()
|
inlinestaticconstexpr |
Definition at line 65 of file dwLidarNode.hpp.
References dw::framework::describePortCollection(), and DW_DESCRIBE_PORT.
◆ describeParameters()
|
inlinestaticconstexpr |
Definition at line 84 of file dwLidarNode.hpp.
References dw::framework::describeConstructorArgument(), DW_DESCRIBE_INDEX_PARAMETER_WITH_SEMANTIC, and DW_DESCRIBE_UNNAMED_PARAMETER.
◆ describePasses()
|
inlinestaticconstexpr |
Definition at line 75 of file dwLidarNode.hpp.
References dw::framework::describePass(), and dw::framework::describePassCollection().
◆ getSensorType()
|
inline |
Definition at line 105 of file dwLidarNode.hpp.
Member Data Documentation
◆ LOG_TAG
|
staticconstexpr |
Definition at line 57 of file dwLidarNode.hpp.
The documentation for this class was generated from the following file:
- src/dwframework/dwnodes/sensors/dwlidarnode/dwLidarNode.hpp
