RobotUnitReader Class Reference

#include <RobotAPI/libraries/armem_robot_state/server/proprioception/RobotUnitReader.h>

+ Inheritance diagram for RobotUnitReader:

Classes

struct  Properties
 

Public Types

using Queue = armarx::armem::server::robot_state::proprioception::Queue
 

Public Member Functions

void connect (armarx::plugins::RobotUnitComponentPlugin &robotUnitPlugin, armarx::plugins::DebugObserverComponentPlugin &debugObserverPlugin, const std::string &robotTypeName)
 
std::optional< RobotUnitDatafetchAndConvertLatestRobotUnitData ()
 
 RobotUnitReader ()
 
void run (float pollFrequency, Queue &dataBuffer)
 Reads data from handler and fills dataQueue. More...
 
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds. More...
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Public Attributes

RobotUnitDataStreaming::Config config
 
exteroception::ConverterInterfaceconverterExteroception = nullptr
 
proprioception::ConverterInterfaceconverterProprioception = nullptr
 
std::optional< DebugObserverHelperdebugObserver
 
RobotUnitDataStreaming::DataStreamingDescription description
 
exteroception::ConverterRegistry exteroceptionConverterRegistry
 
Properties properties
 
ConverterRegistry proprioceptionConverterRegistry
 
RobotUnitDataStreamingReceiverPtr receiver
 
armarx::SimpleRunningTask ::pointer_type task = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

Definition at line 37 of file RobotUnitReader.h.

Member Typedef Documentation

◆ Queue

Constructor & Destructor Documentation

◆ RobotUnitReader()

RobotUnitReader ( )
default

Member Function Documentation

◆ connect()

void connect ( armarx::plugins::RobotUnitComponentPlugin robotUnitPlugin,
armarx::plugins::DebugObserverComponentPlugin debugObserverPlugin,
const std::string &  robotTypeName 
)

Definition at line 19 of file RobotUnitReader.cpp.

+ Here is the call graph for this function:

◆ fetchAndConvertLatestRobotUnitData()

std::optional< RobotUnitData > fetchAndConvertLatestRobotUnitData ( )

Definition at line 80 of file RobotUnitReader.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ run()

void run ( float  pollFrequency,
Queue dataBuffer 
)

Reads data from handler and fills dataQueue.

Definition at line 49 of file RobotUnitReader.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ config

RobotUnitDataStreaming::Config config

Definition at line 71 of file RobotUnitReader.h.

◆ converterExteroception

exteroception::ConverterInterface* converterExteroception = nullptr

Definition at line 78 of file RobotUnitReader.h.

◆ converterProprioception

proprioception::ConverterInterface* converterProprioception = nullptr

Definition at line 77 of file RobotUnitReader.h.

◆ debugObserver

std::optional<DebugObserverHelper> debugObserver

Definition at line 68 of file RobotUnitReader.h.

◆ description

RobotUnitDataStreaming::DataStreamingDescription description

Definition at line 73 of file RobotUnitReader.h.

◆ exteroceptionConverterRegistry

exteroception::ConverterRegistry exteroceptionConverterRegistry

Definition at line 76 of file RobotUnitReader.h.

◆ properties

Properties properties

Definition at line 66 of file RobotUnitReader.h.

◆ proprioceptionConverterRegistry

ConverterRegistry proprioceptionConverterRegistry

Definition at line 75 of file RobotUnitReader.h.

◆ receiver

Definition at line 72 of file RobotUnitReader.h.

◆ task

armarx::SimpleRunningTask ::pointer_type task = nullptr

Definition at line 80 of file RobotUnitReader.h.


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