PDF
AuboStudio SDK  0.6.3
arcs::aubo_scope::InputValidator Struct Referenceabstract

InputValidator Interface representing the input validators created by InputValidationFactory. More...

#include <input_validator.h>

Inheritance diagram for arcs::aubo_scope::InputValidator:

Public Member Functions

virtual bool isValid (std::string value)=0
 Validates whether the input value is valid.
virtual std::string getMessage (std::string value)=0
 Returns a meaningful message in case the value is not valid.

Detailed Description

InputValidator Interface representing the input validators created by InputValidationFactory.

This factory provides a set of standard input validators that can be used for validating the input entered by the user using the virtual keyboard/keypad.

If the standard validators available in the InputValidationFactory does not satisfy your needs, you are free to implement your own custom validator.

Parameters
<T>the (generic) type parameter for the interface representing the type of input data being validated (e.g. Integer or Double).

Definition at line 41 of file input_validator.h.

Member Function Documentation

◆ getMessage()

virtual std::string arcs::aubo_scope::InputValidator::getMessage ( std::string value)
pure virtual

Returns a meaningful message in case the value is not valid.

Parameters
valuethe invalid value. Can be included in the message if it makes sense.
Returns
message.

Implemented in arcs::aubo_scope::DoubleRangeValidator, arcs::aubo_scope::IntegerRangeValidator, arcs::aubo_scope::StringLengthValidator, and arcs::aubo_scope::UIntegerRangeValidator.

◆ isValid()

virtual bool arcs::aubo_scope::InputValidator::isValid ( std::string value)
pure virtual

Validates whether the input value is valid.

Parameters
valueto be validated.
Returns
true if value is valid.

Implemented in arcs::aubo_scope::DoubleRangeValidator, arcs::aubo_scope::IntegerRangeValidator, arcs::aubo_scope::StringLengthValidator, and arcs::aubo_scope::UIntegerRangeValidator.


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