LivePlotController Class Reference

Streams selected memory values to the DebugObserver for live plotting. More...

#include <RobotAPI/libraries/armem_gui/controller/LivePlotController.h>

+ Inheritance diagram for LivePlotController:

Public Types

using MemoryValueID = armem::client::util::MemoryValueID
 

Signals

void startWorkerSignal ()
 
void stopWorkerSignal ()
 
void valuesChanged ()
 

Public Member Functions

bool allPlotted (const std::vector< MemoryValueID > &ids) const
 
bool hasDebugObserver () const
 
bool isPlotted (const MemoryValueID &id) const
 
 LivePlotController (std::shared_ptr< armem::gui::model::MemoryViewerModel > model)
 
void onConnect ()
 
void onDisconnect ()
 
void setPlotted (const std::vector< MemoryValueID > &ids, bool enable)
 
std::vector< MemoryValueIDvaluesSnapshot () const
 
 ~LivePlotController () override
 
- 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.
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Additional Inherited Members

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

Detailed Description

Streams selected memory values to the DebugObserver for live plotting.

Holds the (thread-safe) set of currently plotted values and runs a background worker that periodically reads them from the memory and pushes them to the DebugObserver (reusing MemoryToDebugObserver). Plotted values are highlighted in the views (via valuesChanged) and all created channels are removed when this controller is destroyed (i.e. when the MemoryViewer GUI is closed).

Definition at line 54 of file LivePlotController.h.

Member Typedef Documentation

◆ MemoryValueID

Constructor & Destructor Documentation

◆ LivePlotController()

Definition at line 30 of file LivePlotController.cpp.

+ Here is the call graph for this function:

◆ ~LivePlotController()

~LivePlotController ( )
override

Definition at line 38 of file LivePlotController.cpp.

Member Function Documentation

◆ allPlotted()

bool allPlotted ( const std::vector< MemoryValueID > & ids) const

Definition at line 80 of file LivePlotController.cpp.

◆ hasDebugObserver()

bool hasDebugObserver ( ) const

Definition at line 67 of file LivePlotController.cpp.

◆ isPlotted()

bool isPlotted ( const MemoryValueID & id) const

Definition at line 73 of file LivePlotController.cpp.

◆ onConnect()

void onConnect ( )

Definition at line 127 of file LivePlotController.cpp.

+ Here is the call graph for this function:

◆ onDisconnect()

void onDisconnect ( )

Definition at line 133 of file LivePlotController.cpp.

+ Here is the call graph for this function:

◆ setPlotted()

void setPlotted ( const std::vector< MemoryValueID > & ids,
bool enable )

Definition at line 94 of file LivePlotController.cpp.

+ Here is the call graph for this function:

◆ startWorkerSignal

void startWorkerSignal ( )
signal
+ Here is the caller graph for this function:

◆ stopWorkerSignal

void stopWorkerSignal ( )
signal
+ Here is the caller graph for this function:

◆ valuesChanged

void valuesChanged ( )
signal
+ Here is the caller graph for this function:

◆ valuesSnapshot()

std::vector< LivePlotController::MemoryValueID > valuesSnapshot ( ) const

Definition at line 120 of file LivePlotController.cpp.


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