Handler responsible for how the IMU readings are assembled and provided to the user. More...

#include <IMUOutputHandler.h>

Inheritance diagram for agxSensor::IMUOutputHandler:

Public Member Functions
	IMUOutputHandler ()
	Default constructor.

template<typename T , IMUOutput::Field... field>
OptionalIMUOutputMappnig	add ()
	Build matching IMU output to a given data type T.

OptionalUniqueId	add (IMUOutput *output)
	Add the given IMU output to the output handler.

template<typename T , IMUOutput::Field... field>
bool	add (size_t uniqueId)
	Build matching IMU output to a given data type T and add it mapped to the given unique id.

bool	add (size_t uniqueId, IMUOutput *output)
	Add the given IMU output to the output handler mapped to the given unique id.

IMUOutput *	get (size_t uniqueId)
	Access IMU output instance given the unique id from when it was added.

ISensorOutput *	getBase (size_t uniqueId) override
	Access IMU output instance given the unique id from when it was added.

Public Member Functions inherited from agxSensor::SystemNode
	SystemNode (const SystemNode &)=delete
	Disallow direct copying of nodes.

virtual	~SystemNode ()=default

bool	addChild (SystemNode *child)
	Add unique child to this node.

virtual bool	addNotification ()
	Called when this system node has been added to a sensor environment.

bool	appendChild (SystemNode *child)
	Append child to vector of children, silently.

virtual void	cleanup ()=0
	The sensor environment is being put down, clean everything.

virtual void	complete ()
	Complete the execution of this system, finishing the integration forward in time.

bool	detachChild (SystemNode *child)
	Detach/erase child from vector of children, silently.

virtual bool	eraseAndConnect ()
	Erase this node from the tree and connect its children to the current parent of this node.

virtual void	execute (const CallbackData &data)
	Execute this system, integrating it `data.dt` forward in time.

template<typename T >
T *	findChild (bool recurse=true) const
	Find child of given type.

template<typename PredicateT >
SystemNode *	findChild (PredicateT pred, bool recurse=true) const
	Find child given predicate `pred`.

template<typename T >
T *	findParent () const

template<typename PredicateT >
SystemNode *	findParent (PredicateT pred) const
	Find parent given predicate.

template<typename T >
T *	getChild () const
	Searches children for a node of given type.

SystemNode *	getChild (size_t index) const

bool	getEnable () const

Environment *	getEnvironment () const

const agx::Name &	getName () const

size_t	getNumChildren () const

SystemNode *	getParent () const

SystemNode *	getRoot () const

bool	hasChild (const SystemNode *child, bool recurse=true) const

virtual bool	insertParent (SystemNode &parent)
	Inserts new parent to this node.

virtual bool	onAdd (agx::Referenced &instance)
	Called when an object has been added to the sensor environment.

virtual void	onChildAdded (SystemNode &child)
	Called when `child` has been added to this parent.

virtual void	onChildRemoved (SystemNode &child)
	Called when `child` has been removed from this parent.

virtual bool	onRemove (agx::Referenced &instance)
	Called when an object has been removed from the sensor environment.

bool	removeChild (SystemNode *child)
	Remove child from this node.

virtual void	removeNotification ()
	Called when this system node is being removed from a sensor environment.

virtual void	result (const CallbackData &data)
	If necessary assemble, and fetch results related to this system node after a step by `data.dt` has been completed.

void	setEnable (bool enable)
	Enable/disable this node.

void	setName (const agx::Name &name)
	Assign name to this node.

virtual void	synchronize (const CallbackData &data)
	Synchronization from the main thread.

virtual void	synchronizeGraphics (const agxRender::RenderManager &renderManager)
	At the very end of a step, synchronize any graphics related aspects of the system node.

template<typename VisitorT >
SystemNode *	visitBf (VisitorT visitor) const
	Visit the tree from, including, this node until `callback` returns true - using breadth first traversal.

template<typename VisitorT >
void	visitChildren (VisitorT visitor, bool recurse=true) const
	Visit all children with `func` as void( const SystemNode& child ).

template<typename VisitorT >
SystemNode *	visitChildrenBf (VisitorT visitor) const
	Visit the tree from the children of this node until `callback` returns true - using breadth first traversal.

template<typename VisitorT >
SystemNode *	visitChildrenDf (VisitorT visitor) const
	Visit the tree from the children of this node until `callback` returns true - using depth first traversal.

template<typename T , typename VisitorT >
void	visitChildrenOfType (VisitorT visitor, bool recurse=true) const
	Visit all children with `func` as void( const T& child ).

template<typename VisitorT >
SystemNode *	visitDf (VisitorT visitor) const
	Visit the tree from, including, this node until `callback` returns true - using depth first traversal.

Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.

	Referenced (const Referenced &)

template<typename T >
T *	as ()
	Subclass casting.

template<typename T >
const T *	as () const

template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.

template<typename T >
const T *	asSafe () const

int	getReferenceCount () const

template<typename T >
bool	is () const
	Subclass test.

Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.

void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.

void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

Public Member Functions inherited from agxStream::Serializable
virtual	~Serializable ()
	Destructor for normal C++ use but hidden from SWIG bindings.

virtual const char *	getClassName () const

bool	getEnableSerialization () const

bool	getEnableUuidGeneration ()

agx::UInt32	getIndex () const
	This index is given at creation of this object.

virtual StorageAgent *	getStorageAgent () const =0

agx::Uuid	getUuid () const

bool	isFinished () const

void	setEnableSerialization (bool flag)
	Set to false to disable serialization of this object.

void	setFinished ()
	Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.

void	setUuid (const agx::Uuid &uuid)
	Explicitly set a Uuid on a serializable object.

Public Member Functions inherited from agxSensor::ISensorOutputHandler
	ISensorOutputHandler ()=default
	Default constructor.

ISensorOutput *	get (size_t uniqueId)
	Access sensor output instance given the unique id from when it was added.

virtual ISensorOutput *	getBase (size_t uniqueId)=0
	Access sensor output instance given the unique id from when it was added.

template<typename T >
BinaryOutputView< T >	view (size_t uniqueId)
	Directly access an output view of the sensor output instance given the unique id from when it was added.

Protected Types
using	OutputTable = agx::HashTable< size_t, IMUOutputRef >

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)

Static Public Member Functions inherited from agxStream::Serializable
static void	setEnableUuidGeneration (bool flag)
	Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.

Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.

void	allocateObserverVector () const

void	deleteUsingDeleteHandler () const

Protected Member Functions inherited from agxStream::Serializable
	Serializable ()
	Default constructor.

	Serializable (const Serializable &other)
	Copy constructor.

void	generateUuid ()

Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()

static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.

Protected Attributes inherited from agx::Referenced
Mutex	m_mutex

ObserverContainer	m_observers

AtomicValue	m_refCount

Detailed Description

Handler responsible for how the IMU readings are assembled and provided to the user.

Definition at line 32 of file IMUOutputHandler.h.

Member Typedef Documentation

◆ OutputTable

using agxSensor::IMUOutputHandler::OutputTable = agx::HashTable<size_t, IMUOutputRef>

protected

Definition at line 98 of file IMUOutputHandler.h.

Constructor & Destructor Documentation

◆ IMUOutputHandler()

agxSensor::IMUOutputHandler::IMUOutputHandler ( )

Default constructor.

Member Function Documentation

◆ add() [1/4]

template<typename T , IMUOutput::Field... field>

OptionalIMUOutputMappnig agxSensor::IMUOutputHandler::add

Build matching IMU output to a given data type T.

This method verifies the size of the sum of data fields matches the size of T. The created IMUOutput returned from this method can later be accessed from get() by using the returned uniqueId.

Returns: a pair containing the unique id assigned to the output and the built IMU output

Definition at line 113 of file IMUOutputHandler.h.

◆ add() [2/4]

OptionalUniqueId agxSensor::IMUOutputHandler::add ( IMUOutput * output )

Add the given IMU output to the output handler.

The added IMUOutput can later be accessed from get() by using the returned uniqueId.

Parameters

output - IMU output instance to add

Returns: the unique id assigned to the output on success, or nullopt on failure

◆ add() [3/4]

template<typename T , IMUOutput::Field... field>

bool agxSensor::IMUOutputHandler::add ( size_t uniqueId )

Build matching IMU output to a given data type T and add it mapped to the given unique id.

This method verifies the size of the sum of data fields matches the size of T.

Parameters

uniqueId - unique id > 0, id 0 is reserved and invalid to use

Returns: true if uniqueId > 0 and uniqueId is unique

Definition at line 105 of file IMUOutputHandler.h.

◆ add() [4/4]

bool agxSensor::IMUOutputHandler::add	(	size_t	uniqueId,
		IMUOutput *	output
	)

Add the given IMU output to the output handler mapped to the given unique id.

Parameters

uniqueId	- unique id > 0, id 0 is reserved and invalid to use
output	- IMU output instance to add

Returns: true if uniqueId > 0, uniqueId is unique and output != nullptr

◆ get()

IMUOutput * agxSensor::IMUOutputHandler::get ( size_t uniqueId )

Access IMU output instance given the unique id from when it was added.

Parameters

uniqueId - unique id for the output instance

Returns: output instance for the given unique id if it exists, otherwise nullptr

◆ getBase()

ISensorOutput * agxSensor::IMUOutputHandler::getBase ( size_t uniqueId )

overridevirtual

Access IMU output instance given the unique id from when it was added.

Parameters

uniqueId - unique id for the output instance

Returns: output instance for the given unique id if it exists, otherwise nullptr

Implements agxSensor::ISensorOutputHandler.

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

IMUOutputHandler.h

Public Member Functions

Protected Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ OutputTable

Constructor & Destructor Documentation

◆ IMUOutputHandler()

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ get()

◆ getBase()