Detailed Description

Definition at line 64 of file dwIMUNode.hpp.

Inheritance diagram for dw::framework::dwIMUNode:

[legend]

Collaboration diagram for dw::framework::dwIMUNode:

[legend]

Public Member Functions
	dwIMUNode (const char *sensorName, dwConstRigHandle_t rigHandle, dwSALHandle_t sal, dwContextHandle_t ctx, const FixedString< 32 > &frameSkipMask)

	dwIMUNode (const dwIMUNodeParams &params, const char *sensorName, dwConstRigHandle_t rigHandle, dwSALHandle_t sal, dwContextHandle_t ctx)

	dwIMUNode (const dwSensorParams &params, dwSALHandle_t sal, dwContextHandle_t ctx)

dwSensorType	getSensorType () const

Public Member Functions inherited from dw::framework::ExceptionSafeSensorNode
	ExceptionSafeSensorNode (std::unique_ptr< Node > impl)

dwStatus	getNextTimestamp (dwTime_t &nextTimestamp) final

dwStatus	isVirtual (bool *isVirtualBool) override

dwStatus	setAffinityMask (uint mask) override

dwStatus	setDataEventReadCallback (DataEventReadCallback cb) override

dwStatus	setDataEventWriteCallback (DataEventWriteCallback cb) override

dwStatus	setEndTime (dwTime_t endTime) override

dwStatus	setLockstepDeterministicMode (bool enable) final

dwStatus	setStartTime (dwTime_t startTime) override

dwStatus	setThreadPriority (int prio) override

dwStatus	start () override

dwStatus	stop () override

Public Member Functions inherited from dw::framework::ExceptionSafeProcessNode
dwStatus	clearErrorSignal () override

dwStatus	clearHealthSignal () override

	ExceptionSafeProcessNode (std::unique_ptr< Node > impl)

dwStatus	getErrorSignal (dwGraphErrorSignal &sehErrorSignal, dwGraphErrorSignal &errorSignal, uint16_t const sourceId, char8_t const instanceName=nullptr) 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) 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	updateCurrentErrorSignal (dwGraphErrorSignal &signal) override

dwStatus	updateCurrentHealthSignal (dwGraphHealthSignal &signal) override

dwStatus	validate () override

	~ExceptionSafeProcessNode () override=default

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

virtual dwStatus	getNextTimestamp (dwTime_t &nextTimestamp)=0
	Get the next timestamp of the sensor. More...

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	setLockstepDeterministicMode (bool enable)=0
	Set whether replay is running in lockstep deterministic mode. 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< dwIMUNode >	create (ParameterProvider &provider)

static constexpr auto	describeInputPorts ()

static constexpr auto	describeOutputPorts ()

static constexpr auto	describeParameters ()

static constexpr auto	describePasses ()

Static Public Attributes
static constexpr char8_t	LOG_TAG [] {"dwIMUNode"}

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}

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
ISensorNode *	m_sensorNodeImpl

Protected Attributes inherited from dw::framework::ExceptionSafeProcessNode
std::unique_ptr< Node >	m_impl

Constructor & Destructor Documentation

◆ dwIMUNode() [1/3]

dw::framework::dwIMUNode::dwIMUNode	(	const char *	sensorName,
		dwConstRigHandle_t	rigHandle,
		dwSALHandle_t	sal,
		dwContextHandle_t	ctx,
		const FixedString< 32 > &	frameSkipMask
	)

◆ dwIMUNode() [2/3]

dw::framework::dwIMUNode::dwIMUNode	(	const dwIMUNodeParams &	params,
		const char *	sensorName,
		dwConstRigHandle_t	rigHandle,
		dwSALHandle_t	sal,
		dwContextHandle_t	ctx
	)

◆ dwIMUNode() [3/3]

dw::framework::dwIMUNode::dwIMUNode	(	const dwSensorParams &	params,
		dwSALHandle_t	sal,
		dwContextHandle_t	ctx
	)

Member Function Documentation

◆ create()

static std::unique_ptr< dwIMUNode > dw::framework::dwIMUNode::create ( ParameterProvider & provider )

static

◆ describeInputPorts()

static constexpr auto dw::framework::dwIMUNode::describeInputPorts ( )

inlinestaticconstexpr

Definition at line 74 of file dwIMUNode.hpp.

References dw::framework::describePortCollection(), DW_DESCRIBE_PORT, dw::framework::OPTIONAL, and dw::framework::REQUIRED.

◆ describeOutputPorts()

static constexpr auto dw::framework::dwIMUNode::describeOutputPorts ( )

inlinestaticconstexpr

Definition at line 84 of file dwIMUNode.hpp.

References dw::framework::describePortCollection(), DW_DESCRIBE_PORT, and dw::framework::REQUIRED.

◆ describeParameters()

static constexpr auto dw::framework::dwIMUNode::describeParameters ( )

inlinestaticconstexpr

Definition at line 114 of file dwIMUNode.hpp.

References dw::framework::describeConstructorArgument(), DW_DESCRIBE_PARAMETER, DW_DESCRIBE_PARAMETER_WITH_DEFAULT, DW_DESCRIBE_UNNAMED_PARAMETER, DW_DESCRIBE_UNNAMED_PARAMETER_WITH_SEMANTIC, dw::framework::dwIMUNodeParams::frameSkipMask, and dw::framework::dwIMUNodeParams::inputModeVal.

◆ describePasses()

static constexpr auto dw::framework::dwIMUNode::describePasses ( )

inlinestaticconstexpr

Definition at line 97 of file dwIMUNode.hpp.

References dw::framework::describePass(), and dw::framework::describePassCollection().

◆ getSensorType()

dwSensorType dw::framework::dwIMUNode::getSensorType ( ) const

inline

Definition at line 106 of file dwIMUNode.hpp.

Member Data Documentation

◆ LOG_TAG

constexpr char8_t dw::framework::dwIMUNode::LOG_TAG[] {"dwIMUNode"}

staticconstexpr

Definition at line 71 of file dwIMUNode.hpp.

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

src/dwframework/dwnodes/sensors/dwimunode/dwIMUNode.hpp

Detailed Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ dwIMUNode() [1/3]

◆ dwIMUNode() [2/3]

◆ dwIMUNode() [3/3]

Member Function Documentation

◆ create()

◆ describeInputPorts()

◆ describeOutputPorts()

◆ describeParameters()

◆ describePasses()

◆ getSensorType()

Member Data Documentation

◆ LOG_TAG