AGX Dynamics 2.42.2.1
Loading...
Searching...
No Matches
agxSensor::EncoderOutputHandler Class Reference

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

#include <EncoderOutputHandler.h>

+ Inheritance diagram for agxSensor::EncoderOutputHandler:

Public Member Functions

 EncoderOutputHandler ()
 Default constructor.
 
template<typename T , EncoderOutput::Field... field>
OptionalEncoderOutputMapping add ()
 Build matching encoder output to a given data type T.
 
OptionalUniqueId add (EncoderOutput *output)
 Add the given encoder output to the output handler.
 
bool add (MonoaxialGaussianNoise *noise)
 Add a Gaussian noise instance to the system tree.
 
bool add (MonoaxialSignalResolution *resolution)
 Add a resolution binning instance to the system tree.
 
bool add (MonoaxialSignalScaling *scaling)
 Add a signal scaling instance to the system tree.
 
template<typename T , EncoderOutput::Field... field>
bool add (size_t uniqueId)
 Build matching encoder output to a given data type T and add it mapped to the given unique id.
 
bool add (size_t uniqueId, EncoderOutput *output)
 Add the given encoder output to the output handler mapped to the given unique id.
 
bool contains (const MonoaxialGaussianNoise *noise) const
 
bool contains (const MonoaxialSignalResolution *resolution) const
 
bool contains (const MonoaxialSignalScaling *scaling) const
 
EncoderOutputget (size_t uniqueId)
 Access encoder output instance given the unique id from when it was added.
 
ISensorOutputgetBase (size_t uniqueId) override
 Access encoder output instance given the unique id from when it was added.
 
IMonoaxialSignalSystemNodeRefVector getOutputModifiers () const
 
bool remove (MonoaxialGaussianNoise *noise)
 Remove the Gaussian noise instance from the system tree.
 
bool remove (MonoaxialSignalResolution *resolution)
 Remove the resolution binning instance from the system tree.
 
bool remove (MonoaxialSignalScaling *scaling)
 Remove the signal scaling instance from the system tree.
 
- 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 >
SystemNodefindChild (PredicateT pred, bool recurse=true) const
 Find child given predicate pred.
 
template<typename T >
T * findParent () const
 
template<typename PredicateT >
SystemNodefindParent (PredicateT pred) const
 Find parent given predicate.
 
template<typename T >
T * getChild () const
 Searches children for a node of given type.
 
SystemNodegetChild (size_t index) const
 
bool getEnable () const
 
EnvironmentgetEnvironment () const
 
const agx::NamegetName () const
 
size_t getNumChildren () const
 
SystemNodegetParent () const
 
SystemNodegetRoot () 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 >
SystemNodevisitBf (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 >
SystemNodevisitChildrenBf (VisitorT visitor) const
 Visit the tree from the children of this node until callback returns true - using breadth first traversal.
 
template<typename VisitorT >
SystemNodevisitChildrenDf (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 >
SystemNodevisitDf (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.
 
Referencedoperator= (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.
 
ISensorOutputget (size_t uniqueId)
 Access sensor output instance given the unique id from when it was added.
 
virtual ISensorOutputgetBase (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 Attributes

MonoaxialSignalSystemNodeRefVector m_outputModifiers
 
OutputTable m_outputs
 
SystemNodeRef m_signalAssembler
 
SystemNodeRef m_tailNode
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

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 DeleteHandlergetDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 

Detailed Description

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

Definition at line 36 of file EncoderOutputHandler.h.

Constructor & Destructor Documentation

◆ EncoderOutputHandler()

agxSensor::EncoderOutputHandler::EncoderOutputHandler ( )

Default constructor.

Member Function Documentation

◆ add() [1/7]

template<typename T , EncoderOutput::Field... field>
OptionalEncoderOutputMapping agxSensor::EncoderOutputHandler::add

Build matching encoder 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 EncoderOutput 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 encoder output

Definition at line 196 of file EncoderOutputHandler.h.

◆ add() [2/7]

OptionalUniqueId agxSensor::EncoderOutputHandler::add ( EncoderOutput output)

Add the given encoder output to the output handler.

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

Parameters
output- encoder output instance to add
Returns
the unique id assigned to the output on success, or nullopt on failure

◆ add() [3/7]

bool agxSensor::EncoderOutputHandler::add ( MonoaxialGaussianNoise noise)

Add a Gaussian noise instance to the system tree.

Parameters
noise- output noise to add to the system tree
Returns
true if added successfully, false if nullptr or already added

◆ add() [4/7]

bool agxSensor::EncoderOutputHandler::add ( MonoaxialSignalResolution resolution)

Add a resolution binning instance to the system tree.

Parameters
resolution- output resolution binning to add to the system tree
Returns
true if added successfully, false if nullptr or already added

◆ add() [5/7]

bool agxSensor::EncoderOutputHandler::add ( MonoaxialSignalScaling scaling)

Add a signal scaling instance to the system tree.

Parameters
scaling- signal scaling to add to the system tree
Returns
true if added successfully, false if nullptr or already added

◆ add() [6/7]

template<typename T , EncoderOutput::Field... field>
bool agxSensor::EncoderOutputHandler::add ( size_t  uniqueId)

Build matching encoder 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 188 of file EncoderOutputHandler.h.

◆ add() [7/7]

bool agxSensor::EncoderOutputHandler::add ( size_t  uniqueId,
EncoderOutput output 
)

Add the given encoder 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- encoder output instance to add
Returns
true if uniqueId > 0, uniqueId is unique and output != nullptr

◆ contains() [1/3]

bool agxSensor::EncoderOutputHandler::contains ( const MonoaxialGaussianNoise noise) const
Parameters
noise- noise instance to check if present and active
Returns
true if noise is part of this output handler

◆ contains() [2/3]

bool agxSensor::EncoderOutputHandler::contains ( const MonoaxialSignalResolution resolution) const
Parameters
resolution- resolution binning to check if present and active
Returns
true if resolution is part of this output handler

◆ contains() [3/3]

bool agxSensor::EncoderOutputHandler::contains ( const MonoaxialSignalScaling scaling) const
Parameters
scaling- signal scaling instance to check if present and active
Returns
true if scaling is part of this output handler

◆ get()

EncoderOutput * agxSensor::EncoderOutputHandler::get ( size_t  uniqueId)

Access encoder 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::EncoderOutputHandler::getBase ( size_t  uniqueId)
overridevirtual

Access encoder 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.

◆ getOutputModifiers()

IMonoaxialSignalSystemNodeRefVector agxSensor::EncoderOutputHandler::getOutputModifiers ( ) const
Returns
all added and active output modifiers

◆ remove() [1/3]

bool agxSensor::EncoderOutputHandler::remove ( MonoaxialGaussianNoise noise)

Remove the Gaussian noise instance from the system tree.

The noise will no longer be applied to the output data if removed successfully.

Parameters
noise- noise to remove
Returns
true if removed successfully, false if nullptr or not part of this system tree

◆ remove() [2/3]

bool agxSensor::EncoderOutputHandler::remove ( MonoaxialSignalResolution resolution)

Remove the resolution binning instance from the system tree.

The resolution binning will no longer be applied to the output data if removed successfully.

Parameters
resolution- resolution binning to remove
Returns
true if removed successfully, false if nullptr or not part of this system tree

◆ remove() [3/3]

bool agxSensor::EncoderOutputHandler::remove ( MonoaxialSignalScaling scaling)

Remove the signal scaling instance from the system tree.

The scaling will no longer be applied to the output data if removed successfully.

Parameters
scaling- scaling to remove
Returns
true if removed successfully, false if nullptr or not part of this system tree

Member Data Documentation

◆ m_outputModifiers

MonoaxialSignalSystemNodeRefVector agxSensor::EncoderOutputHandler::m_outputModifiers
protected

Definition at line 182 of file EncoderOutputHandler.h.

◆ m_outputs

OutputTable agxSensor::EncoderOutputHandler::m_outputs
protected

Definition at line 181 of file EncoderOutputHandler.h.

◆ m_signalAssembler

SystemNodeRef agxSensor::EncoderOutputHandler::m_signalAssembler
protected

Definition at line 183 of file EncoderOutputHandler.h.

◆ m_tailNode

SystemNodeRef agxSensor::EncoderOutputHandler::m_tailNode
protected

Definition at line 184 of file EncoderOutputHandler.h.


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