Configuration Variable for MACADR object type.
More...
#include <config_obj.h>
Inherits config_value.
|
virtual void | GetTextValue (NBString &s) |
| Get the object value as a text string with quotations to the specified NBString object.
|
|
| config_MACADR (config_obj &owner, MACADR def_val, const char *name, const char *desc=NULL) |
| Object constructor with the parent/owner leaf parameter.
|
|
| config_MACADR (MACADR def_val, const char *name, const char *desc=NULL) |
| Object constructor.
|
|
| config_MACADR (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL) |
| Object constructor with the parent/owner leaf parameter.
|
|
| config_MACADR (const char *def_val, const char *name, const char *desc=NULL) |
| Object constructor.
|
|
| operator MACADR () const |
| Returns the object value.
|
|
config_MACADR & | operator= (const config_MACADR &ci) |
| Copy one config_MACADR object to another.
|
|
config_MACADR & | operator= (const MACADR &ci) |
| Copy a MACADR object value to a MACADR object.
|
|
virtual void | GetTypeValue (NBString &s) |
| Copy the object type value to the specified NBString object.
|
|
|
| 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.
|
|
Configuration Variable for MACADR object type.
- Note
- All modifictions to configuration objects are marked as pending. A call to SaveConfigToStorage is required to save changes to flash memory.
◆ config_MACADR() [1/4]
config_MACADR::config_MACADR |
( |
config_obj & | owner, |
|
|
MACADR | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor with the parent/owner leaf parameter.
Default value assigned with an MACADR object
- Parameters
-
owner | Reference to owner/parent leaf |
def_val | Default value of type MACADR |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_MACADR() [2/4]
config_MACADR::config_MACADR |
( |
MACADR | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor.
Default value assigned with an MACADR object
- Parameters
-
def_val | Default value of type MACADR |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_MACADR() [3/4]
config_MACADR::config_MACADR |
( |
config_obj & | owner, |
|
|
const char * | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor with the parent/owner leaf parameter.
Default value is assigned with a const char * string. The AsciiToMac() function is used to convert the string to a MACADR.
- Parameters
-
owner | Reference to owner/parent leaf |
def_val | Default MAC Address value of type char *. The hexidical format must be 6 octets, with or without ':' separators. For example, "0123456789AB", or "01:23:45:67:89:AB" |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_MACADR() [4/4]
config_MACADR::config_MACADR |
( |
const char * | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor.
Default value is assigned with a const char * string. The AsciiToMac() function is used to convert the string to a MACADR.
- Parameters
-
def_val | Default MAC Address value of type char *. The hexidical format must be 6 octets, with or without ':' separators. For example, "0123456789AB", or "01:23:45:67:89:AB" |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ GetTextValue()
virtual void config_MACADR::GetTextValue |
( |
NBString & | s | ) |
|
|
inlinevirtual |
Get the object value as a text string with quotations to the specified NBString object.
The format is the hexadecimal address: "xx:xx:xx:xx:xx:xx" 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_MACADR::GetTypeValue |
( |
NBString & | s | ) |
|
|
inlinevirtual |
Copy the object type value to the specified NBString object.
The type value "string" is written to the NBString object.
- Parameters
-
s | NBString object to hold the type value string |
◆ operator MACADR()
config_MACADR::operator MACADR |
( |
| ) |
const |
|
inline |
Returns the object value.
- Returns
- The value of the object as a MACADR
◆ operator=() [1/2]
◆ operator=() [2/2]
The documentation for this class was generated from the following file: