ConfigNumber< T > Class Template Reference

Inheritance diagram for ConfigNumber< T >:

Public Member Functions
	ConfigNumber (const char *name, Storage &s, uint64_t addr, T min, T max, void(*onSet)(T)=nullptr)
const char *	getName () override
virtual bool	handleCommand (const char *input, Print &p) override
virtual void	print (Print &p) override
virtual T	getValue ()
virtual error_t	setValue (T newValue)
virtual bool	isValid () override
virtual void	printHelp (Print &p) override

Protected Member Functions
virtual void	onValueSet () override

Protected Attributes
char *	name
Storage &	flash
const uint64_t	addr
T	min
T	max
void(*	onSet )(T)

Detailed Description

template<typename T>
class ConfigNumber< T >

Examples

plm150/PLS100W_RD-WSD-M-02/main.cpp.

Constructor & Destructor Documentation

ConfigNumber()

template<typename T>

ConfigNumber< T >::ConfigNumber ( const char * name, Storage & s, uint64_t addr, T min, T max, void(* onSet )(T) = nullptr )

inline

    : flash(s), addr(addr), min(min), max(max), onSet(onSet) {
    this->name = new char[strlen(name) + 1];
    strcpy(this->name, name);
  };

Member Function Documentation

getName()

template<typename T>

const char * ConfigNumber< T >::getName ( )

inlineoverridevirtual

Implements ConfigItem.

                                 {
    return this->name;
  };

getValue()

template<typename T>

virtual T ConfigNumber< T >::getValue ( )

inlinevirtual

                       {
    T val;
    this->flash.read(&val, this->addr, sizeof(T));
    return val;
  };

handleCommand()

template<typename T>

virtual bool ConfigNumber< T >::handleCommand ( const char * input, Print & p )

inlineoverridevirtual

Implements ConfigItem.

                                                                   {
    std::string command = "get ";
    command += this->name;
 
    if (command == input) {
      p.printf("\"result\":\"OK\",\"%s\":", this->name);
      this->print(p);
      return true;
    }
 
    command = "set ";
    command += this->name;
    command += ' ';
 
    std::string inputCommand = input;
    if (inputCommand.find(command) == 0) {
      const char *value = inputCommand.substr(command.length()).c_str();
      char *pos = nullptr;
 
      T v = strtol(value, &pos, 0);
      if (*pos == '\0') {
        error_t err = this->setValue(v);
        if (err == ERROR_INVALID_ARGS && (v < this->min || v > this->max)) {
          p.print("\"result\":\"out of range error\"");
          return true;
        } else if (err == ERROR_SUCCESS) {
          p.printf("\"result\":\"OK\",\"%s\":", this->name);
          this->print(p);
          this->onValueSet();
        } else {
          p.printf("\"result\":\"error (%d)\"", err);
        }
      } else {
        p.printf("\"result\":\"parsing error: %s -> %d\"", value, v);
      }
 
      return true;
    }
 
    return false;
  };

isValid()

template<typename T>

virtual bool ConfigNumber< T >::isValid ( )

inlineoverridevirtual

Implements ConfigItem.

                                 {
    T val = this->getValue();
    return (val >= this->min && val <= this->max);
  }

onValueSet()

template<typename T>

virtual void ConfigNumber< T >::onValueSet ( )

inlineoverrideprotectedvirtual

Reimplemented from ConfigItem.

                                     {
    if (this->onSet) {
      this->onSet(this->getValue());
    }
  };

print()

template<typename T>

virtual void ConfigNumber< T >::print ( Print & p )

inlineoverridevirtual

Implements ConfigItem.

                                        {
    T val = this->getValue();
    p.print(val);
    if (val < this->min || val > this->max) {
      p.print(" /* out of range */");
    }
  };

printHelp()

template<typename T>

virtual void ConfigNumber< T >::printHelp ( Print & p )

inlineoverridevirtual

Implements ConfigItem.

                                           {
    p.printf("[\"get %s\"", this->getName());
    p.printf(",\"set %s [", this->getName());
    p.print(this->min);
    p.print('~');
    p.print(this->max);
    p.print("]\"]");
  }

setValue()

template<typename T>

virtual error_t ConfigNumber< T >::setValue ( T newValue )

inlinevirtual

                                       {
    if (newValue < this->min || newValue > this->max) {
      return ERROR_INVALID_ARGS;
    }
        
    return this->flash.write((const uint8_t *) &newValue, this->addr, sizeof(T));
  };

---

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

• include/ConfigNumber.hpp