Configuration Variable for IPADDR4 (IPv4) object types.
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_IPADDR4 (config_obj &owner, IPADDR4 def_val, const char *name, const char *desc=NULL) |
| Object constructor with the parent/owner leaf parameter.
|
|
| config_IPADDR4 (IPADDR4 def_val, const char *name, const char *desc=NULL) |
| Object constructor.
|
|
| config_IPADDR4 (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL) |
| Object constructor with the parent/owner leaf parameter.
|
|
| config_IPADDR4 (const char *def_val, const char *name, const char *desc=NULL) |
| Object constructor.
|
|
| operator IPADDR4 () const |
| Returns the object value.
|
|
bool | IsNull () const |
| Check if the IP address is null.
|
|
bool | NotNull () const |
| Check if the IP address is not null.
|
|
void | SetNull () |
| Set the IP address to null.
|
|
config_IPADDR4 & | operator= (const IPADDR4 &i4) |
| Copy an IPADDR4 object value to a config_IPADDR4 object.
|
|
config_IPADDR4 & | operator= (const config_IPADDR4 &ci) |
| Copy one config_IPADDR4 object to another.
|
|
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 IPADDR4 (IPv4) object types.
- See also
- config_IPADDR
- Note
- All modifictions to configuration objects are marked as pending. A call to SaveConfigToStorage is required to save changes to flash memory.
◆ config_IPADDR4() [1/4]
config_IPADDR4::config_IPADDR4 |
( |
config_obj & | owner, |
|
|
IPADDR4 | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor with the parent/owner leaf parameter.
Default value assigned with an IPADDR4 object
- Parameters
-
owner | Reference to owner/parent leaf |
def_val | Default value of type IPADDR4 |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_IPADDR4() [2/4]
config_IPADDR4::config_IPADDR4 |
( |
IPADDR4 | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor.
Default value assigned with an IPADDR4 object
- Parameters
-
def_val | Default value of type NBString |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_IPADDR4() [3/4]
config_IPADDR4::config_IPADDR4 |
( |
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 assigned with an const char * string. IP address is converted using the IPADDR4 SetFromAscii() member function.
- Parameters
-
owner | Reference to owner/parent leaf |
def_val | Default value of type char *. Format is: "xxx.xxx.xxx.xxx". For example, "10.1.1.100" |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ config_IPADDR4() [4/4]
config_IPADDR4::config_IPADDR4 |
( |
const char * | def_val, |
|
|
const char * | name, |
|
|
const char * | desc = NULL ) |
|
inline |
Object constructor.
Default value assigned with an const char * string. IP address is converted using the IPADDR4 SetFromAscii() member function.
- Parameters
-
def_val | Default value of type char *. Format is: "xxx.xxx.xxx.xxx". For example, "10.1.1.100" |
name | Field name assigned to the value |
desc | Description used for info/tool tip |
◆ GetTextValue()
virtual void config_IPADDR4::GetTextValue |
( |
NBString & | s | ) |
|
|
inlinevirtual |
Get the object value as a text string with quotations to the specified NBString object.
The format of the string is: "xxx.xxx.xxx.xxx". 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_IPADDR4::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 |
◆ IsNull()
bool config_IPADDR4::IsNull |
( |
| ) |
const |
|
inline |
Check if the IP address is null.
- Return values
-
true | if the IP address value is null |
- See also
- NotNull(), SetNull()
◆ NotNull()
bool config_IPADDR4::NotNull |
( |
| ) |
const |
|
inline |
Check if the IP address is not null.
- Return values
-
true | if the IP address value is not null |
- See also
- IsNull(), SetNull()
◆ operator IPADDR4()
config_IPADDR4::operator IPADDR4 |
( |
| ) |
const |
|
inline |
Returns the object value.
- Returns
- The value of the object as an IPADDR4
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ SetNull()
void config_IPADDR4::SetNull |
( |
| ) |
|
|
inline |
The documentation for this class was generated from the following file: