config_IPADDR Class Reference

Configuration Variable for IPADDR (IPv6) object type. More...

#include <config_obj.h>

Inherits config_value.

Public Member Functions
virtual void	GetTextValue (NBString &s) override
	Get the object value as a text string with quotations to the specified NBString object.
	config_IPADDR (config_obj &owner, IPADDR def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_IPADDR (IPADDR def_val, const char *name, const char *desc=NULL)
	Object constructor.
	config_IPADDR (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_IPADDR (const char *def_val, const char *name, const char *desc=NULL)
	Object constructor.
	operator IPADDR () 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 value of an config_IPADDR object to null.
config_IPADDR &	operator= (const IPADDR &i6)
	Copy an IPADDR object value to a config_IPADDR object.
config_IPADDR &	operator= (const config_IPADDR &ci)
	Copy one config_IPADDR object to another.
virtual void	GetTypeValue (NBString &s) override
	Copy the object type value to the specified NBString object.

Additional Inherited Members
Protected Member Functions inherited from config_value
	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.

Detailed Description

Configuration Variable for IPADDR (IPv6) object type.

See also

config_IPADDR4

Note

All modifictions to configuration objects are marked as pending. A call to SaveConfigToStorage is required to save changes to flash memory.

Constructor & Destructor Documentation

config_IPADDR() [1/4]

config_IPADDR::config_IPADDR ( config_obj & owner, IPADDR def_val, const char * name, const char * desc = NULL )

inline

Object constructor with the parent/owner leaf parameter.

Default value assigned with an IPADDR object

Parameters

owner	Reference to owner/parent leaf
def_val	Default value of type IPADDR
name	Field name assigned to the value
desc	Description used for info/tool tip

config_IPADDR() [2/4]

config_IPADDR::config_IPADDR ( IPADDR def_val, const char * name, const char * desc = NULL )

inline

Object constructor.

Default value assigned with an IPADDR object

Parameters

def_val	Default value of type NBString
name	Field name assigned to the value
desc	Description used for info/tool tip

config_IPADDR() [3/4]

config_IPADDR::config_IPADDR ( 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 SetFromAscii() IPADDR member function.

Parameters

owner	Reference to owner/parent leaf
def_val	Default value of type char * in IPv6 format
name	Field name assigned to the value
desc	Description used for info/tool tip

config_IPADDR() [4/4]

config_IPADDR::config_IPADDR ( 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 SetFromAscii() IPADDR member function.

Parameters

def_val	Default value of type char * in IPv6 format
name	Field name assigned to the value
desc	Description used for info/tool tip

Member Function Documentation

GetTextValue()

virtual void config_IPADDR::GetTextValue ( NBString & s )

inlineoverridevirtual

Get the object value as a text string with quotations 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_IPADDR::GetTypeValue ( NBString & s )

inlineoverridevirtual

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_IPADDR::IsNull ( ) const

inline

Check if the IP address is null.

Return values

true	if the IP address value is null

See also

NotNull()

NotNull()

bool config_IPADDR::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()

operator IPADDR()

config_IPADDR::operator IPADDR ( ) const

inline

Returns the object value.

Returns

The value of the object as an IPADDR object

operator=() [1/2]

config_IPADDR & config_IPADDR::operator= ( const config_IPADDR & ci )

inline

Copy one config_IPADDR object to another.

Parameters

ci	Reference to a config_IPADDR object

operator=() [2/2]

config_IPADDR & config_IPADDR::operator= ( const IPADDR & i6 )

inline

Copy an IPADDR object value to a config_IPADDR object.

Parameters

i6	Reference to an IPADDR object

---

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

• config_obj.h