Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Private Attributes | List of all members
corbo::gui::ToolboxWidget Class Reference

#include <toolbox_widget.h>

Inheritance diagram for corbo::gui::ToolboxWidget:
Inheritance graph
[legend]

Public Slots

void getAvailableSignals ()
 
void loadParametersFromFile ()
 
void loadParametersFromFile (const QString &filepath)
 
void removeFromTaskCache (int task_id)
 
void requestParametersFromService ()
 
void restoreTaskParameters (int task_id)
 
void saveCurrentParametersToFile ()
 
void saveParametersToFile (int task_id)
 

Signals

void parameterLoadedFromFile (const QString &filename)
 
void parameterSavedToFile (const QString &filename)
 
void taskCompleted (const QDateTime &time)
 

Public Member Functions

void clearParameters ()
 
void fromMessage (const google::protobuf::Message &parameters)
 
QVector< ParameterWidget * > getParameterWidgets ()
 
void setRpcClient (std::shared_ptr< MasterServiceClient > rpc_client)
 
void setSignalAutoRequest (bool active)
 
QSize sizeHint () const override
 
void toMessage (google::protobuf::Message &parameters) const
 
 ToolboxWidget (SignalHelper::Ptr signal_helper, std::shared_ptr< MasterServiceClient > rpc, QWidget *parent=0)
 
virtual ~ToolboxWidget ()
 

Protected Slots

void performTask ()
 
void rpcTaskFinished (bool success, const QString &msg)
 

Protected Member Functions

void createToolboxContent ()
 
void initializeToolboxes ()
 
void saveParametersToFile (const google::protobuf::Message &params)
 
bool sendParametersToService (bool suppress_warning=false)
 
void setTaskRunningFlag (bool running)
 
void updateParameterWidgets ()
 

Private Attributes

QPushButton * _btn_perform_task
 
ParameterCache _param_cache
 
std::unique_ptr< google::protobuf::Message > _param_message
 Internal cache of the current parameter setting/message. More...
 
QVector< ParameterWidget * > _param_widgets
 
std::shared_ptr< MasterServiceClient > _rpc_client
 
QThread _rpc_task_thread
 
bool _signal_auto_update = false
 
SignalHelper::Ptr _signal_helper
 
const QString _task_button_label_active = "Perform Task"
 
const QString _task_button_label_inactive = "Stop Task"
 
ParameterCache _task_cache
 
bool _task_running = false
 Keep track if a task is currently running. More...
 
QToolBox * _toolbox
 

Detailed Description

Definition at line 90 of file toolbox_widget.h.

Constructor & Destructor Documentation

◆ ToolboxWidget()

corbo::gui::ToolboxWidget::ToolboxWidget ( SignalHelper::Ptr  signal_helper,
std::shared_ptr< MasterServiceClient >  rpc,
QWidget *  parent = 0 
)
explicit

Definition at line 82 of file toolbox_widget.cpp.

◆ ~ToolboxWidget()

corbo::gui::ToolboxWidget::~ToolboxWidget ( )
virtual

Definition at line 95 of file toolbox_widget.cpp.

Member Function Documentation

◆ clearParameters()

void corbo::gui::ToolboxWidget::clearParameters ( )

Definition at line 405 of file toolbox_widget.cpp.

◆ createToolboxContent()

void corbo::gui::ToolboxWidget::createToolboxContent ( )
protected

Definition at line 103 of file toolbox_widget.cpp.

◆ fromMessage()

void corbo::gui::ToolboxWidget::fromMessage ( const google::protobuf::Message &  parameters)

Definition at line 421 of file toolbox_widget.cpp.

◆ getAvailableSignals

void corbo::gui::ToolboxWidget::getAvailableSignals ( )
slot

Definition at line 304 of file toolbox_widget.cpp.

◆ getParameterWidgets()

QVector<ParameterWidget*> corbo::gui::ToolboxWidget::getParameterWidgets ( )
inline

Definition at line 122 of file toolbox_widget.h.

◆ initializeToolboxes()

void corbo::gui::ToolboxWidget::initializeToolboxes ( )
protected

Definition at line 138 of file toolbox_widget.cpp.

◆ loadParametersFromFile [1/2]

void corbo::gui::ToolboxWidget::loadParametersFromFile ( )
slot

Definition at line 371 of file toolbox_widget.cpp.

◆ loadParametersFromFile [2/2]

void corbo::gui::ToolboxWidget::loadParametersFromFile ( const QString &  filepath)
slot

Definition at line 379 of file toolbox_widget.cpp.

◆ parameterLoadedFromFile

void corbo::gui::ToolboxWidget::parameterLoadedFromFile ( const QString &  filename)
signal

◆ parameterSavedToFile

void corbo::gui::ToolboxWidget::parameterSavedToFile ( const QString &  filename)
signal

◆ performTask

void corbo::gui::ToolboxWidget::performTask ( )
protectedslot

Definition at line 248 of file toolbox_widget.cpp.

◆ removeFromTaskCache

void corbo::gui::ToolboxWidget::removeFromTaskCache ( int  task_id)
slot

Definition at line 329 of file toolbox_widget.cpp.

◆ requestParametersFromService

void corbo::gui::ToolboxWidget::requestParametersFromService ( )
slot

Definition at line 208 of file toolbox_widget.cpp.

◆ restoreTaskParameters

void corbo::gui::ToolboxWidget::restoreTaskParameters ( int  task_id)
slot

Definition at line 320 of file toolbox_widget.cpp.

◆ rpcTaskFinished

void corbo::gui::ToolboxWidget::rpcTaskFinished ( bool  success,
const QString &  msg 
)
protectedslot

Definition at line 275 of file toolbox_widget.cpp.

◆ saveCurrentParametersToFile

void corbo::gui::ToolboxWidget::saveCurrentParametersToFile ( )
slot

Definition at line 331 of file toolbox_widget.cpp.

◆ saveParametersToFile() [1/2]

void corbo::gui::ToolboxWidget::saveParametersToFile ( const google::protobuf::Message &  params)
protected

Definition at line 346 of file toolbox_widget.cpp.

◆ saveParametersToFile [2/2]

void corbo::gui::ToolboxWidget::saveParametersToFile ( int  task_id)
slot

Definition at line 337 of file toolbox_widget.cpp.

◆ sendParametersToService()

bool corbo::gui::ToolboxWidget::sendParametersToService ( bool  suppress_warning = false)
protected

Definition at line 222 of file toolbox_widget.cpp.

◆ setRpcClient()

void corbo::gui::ToolboxWidget::setRpcClient ( std::shared_ptr< MasterServiceClient >  rpc_client)

Definition at line 410 of file toolbox_widget.cpp.

◆ setSignalAutoRequest()

void corbo::gui::ToolboxWidget::setSignalAutoRequest ( bool  active)
inline

Definition at line 124 of file toolbox_widget.h.

◆ setTaskRunningFlag()

void corbo::gui::ToolboxWidget::setTaskRunningFlag ( bool  running)
protected

Definition at line 436 of file toolbox_widget.cpp.

◆ sizeHint()

QSize corbo::gui::ToolboxWidget::sizeHint ( ) const
override

Definition at line 101 of file toolbox_widget.cpp.

◆ taskCompleted

void corbo::gui::ToolboxWidget::taskCompleted ( const QDateTime &  time)
signal

◆ toMessage()

void corbo::gui::ToolboxWidget::toMessage ( google::protobuf::Message &  parameters) const

Definition at line 429 of file toolbox_widget.cpp.

◆ updateParameterWidgets()

void corbo::gui::ToolboxWidget::updateParameterWidgets ( )
protected

Definition at line 176 of file toolbox_widget.cpp.

Member Data Documentation

◆ _btn_perform_task

QPushButton* corbo::gui::ToolboxWidget::_btn_perform_task
private

Definition at line 163 of file toolbox_widget.h.

◆ _param_cache

ParameterCache corbo::gui::ToolboxWidget::_param_cache
private

Definition at line 168 of file toolbox_widget.h.

◆ _param_message

std::unique_ptr<google::protobuf::Message> corbo::gui::ToolboxWidget::_param_message
private

Internal cache of the current parameter setting/message.

Definition at line 165 of file toolbox_widget.h.

◆ _param_widgets

QVector<ParameterWidget*> corbo::gui::ToolboxWidget::_param_widgets
private

Definition at line 166 of file toolbox_widget.h.

◆ _rpc_client

std::shared_ptr<MasterServiceClient> corbo::gui::ToolboxWidget::_rpc_client
private

Definition at line 172 of file toolbox_widget.h.

◆ _rpc_task_thread

QThread corbo::gui::ToolboxWidget::_rpc_task_thread
private

Definition at line 176 of file toolbox_widget.h.

◆ _signal_auto_update

bool corbo::gui::ToolboxWidget::_signal_auto_update = false
private

Definition at line 174 of file toolbox_widget.h.

◆ _signal_helper

SignalHelper::Ptr corbo::gui::ToolboxWidget::_signal_helper
private

Definition at line 171 of file toolbox_widget.h.

◆ _task_button_label_active

const QString corbo::gui::ToolboxWidget::_task_button_label_active = "Perform Task"
private

Definition at line 179 of file toolbox_widget.h.

◆ _task_button_label_inactive

const QString corbo::gui::ToolboxWidget::_task_button_label_inactive = "Stop Task"
private

Definition at line 180 of file toolbox_widget.h.

◆ _task_cache

ParameterCache corbo::gui::ToolboxWidget::_task_cache
private

Definition at line 169 of file toolbox_widget.h.

◆ _task_running

bool corbo::gui::ToolboxWidget::_task_running = false
private

Keep track if a task is currently running.

Definition at line 177 of file toolbox_widget.h.

◆ _toolbox

QToolBox* corbo::gui::ToolboxWidget::_toolbox
private

Definition at line 162 of file toolbox_widget.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Wed Mar 2 2022 00:07:22