Unsigned 32-bit Integer Configuration Variable.
More...
#include <config_obj.h>
Inherits config_value.
Inherited by config_hex_uint.
|
| config_value (config_obj &owner, const char *name, const char *desc) |
| Object constructor with the parent/owner leaf parameter.
|
|
| config_value (const char *name, const char *desc) |
| Object constructor.
|
|
Unsigned 32-bit Integer Configuration Variable.
- Note
- All modifications to configuration objects are marked as pending. A call to SaveConfigToStorage is required to save changes to flash memory.
◆ config_uint() [1/2]
config_uint::config_uint |
( |
config_obj & | owner, |
|
|
uint32_t | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor with the parent/owner leaf parameter.
- Parameters
-
owner | Reference to owner/parent leaf |
def_val | Default value |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_uint() [2/2]
config_uint::config_uint |
( |
uint32_t | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor.
- Parameters
-
def_val | Default value |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ GetTextValue()
virtual void config_uint::GetTextValue |
( |
NBString & | s | ) |
|
|
inlinevirtual |
Copy the object value to the specified NBString object.
This is a virtual function that can be overridden in any derived class.
- Parameters
-
s | Reference to a NBString object to store the result |
Implements config_value.
◆ GetTypeValue()
virtual void config_uint::GetTypeValue |
( |
NBString & | s | ) |
|
|
inlinevirtual |
Copy the object type value to the specified NBString object.
The type value "integer" is written to the NBString object.
- Parameters
-
s | NBString object to hold the type value string |
◆ operator uint32_t()
config_uint::operator uint32_t |
( |
| ) |
const |
|
inline |
Return the object value.
- Returns
- The value of the object as a uint32_t
Example: for a variable named configuInt of type config_uint:
uint32_t value = uint32_t(configuInt);
iprintf("int = %ld\r\n", value);
◆ operator=() [1/2]
◆ operator=() [2/2]
config_uint & config_uint::operator= |
( |
const uint32_t | i | ) |
|
|
inline |
Assign the config_uint object value from a uint32_t value.
- Parameters
-
The documentation for this class was generated from the following file: