config_pass Class Reference

Password string Configuration Variable. More...

#include <config_obj.h>

Inherits config_string.

Inherited by config_pass_limit.

Public Member Functions
	config_pass (config_obj &owner, NBString def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_pass (NBString def_val, const char *name, const char *desc=NULL)
	Object constructor.
	config_pass (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_pass (const char *def_val, const char *name, const char *desc=NULL)
	Object constructor.
virtual void	GetTextValue (NBString &s) override
	Get the config_pass object value as a text string.
virtual void	GetRawValue (NBString &s) override
	Copy the raw config_string object value to the NBString object.
	operator NBString () const
	Returns the object value.
config_pass &	operator= (const char *p)
	Assign the config_pass object value from a const char* value.
config_pass &	operator= (const NBString &s)
	Assign the config_pass object value from a NBString object.
config_pass &	operator= (const config_string &ci)
	Copy a config_string object to a config_pass object.
config_pass &	operator= (const config_pass &ci)
	Copy one config_pass object to another.
Public Member Functions inherited from config_string
	config_string (config_obj &owner, NBString def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_string (NBString def_val, const char *name, const char *desc=NULL)
	Object constructor.
	config_string (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_string (const char *def_val, const char *name, const char *desc=NULL)
	Object constructor.
void	SetEnumList (NBString s)
	Renders the data used to explain the schema/descriptions for the list of choices.
	operator NBString () const
	Return the object value.
config_string &	operator= (const char *p)
	Assign the config_string object value from a const char* string.
config_string &	operator= (const NBString &s)
	Assign the config_string object value from a NBString object.
config_string &	operator= (const config_string &ci)
	Copy one config_string object to another.
const char *	c_str () const
	Returns the object value as a string.
size_t	length () const
	Returns the string length in bytes.
const char &	operator[] (size_t pos) const
	Return the value of a character in the string.
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

Password string Configuration Variable.

A config_pass is like a config_string, but the data is hidden by '*' characters.

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_pass() [1/4]

config_pass::config_pass ( config_obj & owner, NBString def_val, const char * name, const char * desc = NULL )

inline

Object constructor with the parent/owner leaf parameter.

Default value is assigned with a NBString

Parameters

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

config_pass() [2/4]

config_pass::config_pass ( NBString def_val, const char * name, const char * desc = NULL )

inline

Object constructor.

Default value is assigned with a NBString

Parameters

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

config_pass() [3/4]

config_pass::config_pass ( 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 character string

Parameters

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

config_pass() [4/4]

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

inline

Object constructor.

Default value is assigned with a character string

Parameters

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

Member Function Documentation

GetRawValue()

virtual void config_pass::GetRawValue ( NBString & s )

overridevirtual

Copy the raw config_string object value to the NBString object.

Parameters

s	Reference to a NBString object

This is a virtual function that can be overridden in any derived class.

GetTextValue()

virtual void config_pass::GetTextValue ( NBString & s )

overridevirtual

Get the config_pass object value as a text string.

This is a virtual function that can be overridden in any derived class.

Parameters

s	Reference to a NBString object to store the result

Reimplemented from config_string.

operator NBString()

config_pass::operator NBString ( ) const

inline

Returns the object value.

Returns

The value of the object as a NBString

operator=() [1/4]

config_pass & config_pass::operator= ( const char * p )

inline

Assign the config_pass object value from a const char* value.

Parameters

p	String to assign

operator=() [2/4]

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

inline

Copy one config_pass object to another.

Parameters

ci	Reference to a config_pass object

operator=() [3/4]

config_pass & config_pass::operator= ( const config_string & ci )

inline

Copy a config_string object to a config_pass object.

Parameters

ci	Reference to a config_string object

operator=() [4/4]

config_pass & config_pass::operator= ( const NBString & s )

inline

Assign the config_pass object value from a NBString object.

Parameters

s	Reference to a NBString object

---

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

• config_obj.h