arcs::aubo_scope::ScrewdriverProgram Class Reference

This abstract class represents a screwdriver program, typically defined on an external control box for the screwdriver. More...

#include <screw_driver_parameters.h>

Public Member Functions
virtual	~ScrewdriverProgram ()=0
virtual std::string	getId ()=0
virtual std::string	getDisplayName ()=0

Detailed Description

This abstract class represents a screwdriver program, typically defined on an external control box for the screwdriver.

Definition at line 15 of file screw_driver_parameters.h.

Constructor & Destructor Documentation

virtual arcs::aubo_scope::ScrewdriverProgram::~ScrewdriverProgram ( )

pure virtual

Member Function Documentation

virtual std::string arcs::aubo_scope::ScrewdriverProgram::getDisplayName ( )

pure virtual

This method should return the name of the screwdriver program. The name will be displayed in the UI, e.g. in a combo box. The name returned is allowed to change over versions of the driver AuboCap as well as be different depending on the current language selected in AuboScope, in case translations are supported.

This method must be implemented.

Returns

the name of the screwdriver program to display in the UI.

virtual std::string arcs::aubo_scope::ScrewdriverProgram::getId ( )

pure virtual

This method must return an identifier to uniquely identify this screwdriver program. The identifier will be used for persistence and resolving the correct screwdriver program. Therefore the identifier must remain constant over time and versions of the screwdriver AuboCap.

This method must be implemented.

Returns

a unique identifier string which will remain constant over time and versions of the screwdriver AuboCap.

---

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

• include/aubo_caps/contribution/driver/screw_driver/screw_driver_parameters.h