config_string_limit Class Reference

A config_string with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI. More...

#include <config_obj.h>

Inherits config_string.

Public Member Functions
	config_string_limit (config_obj &owner, NBString def_val, size_t minl=0, size_t maxl=0, const char *name=NULL, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter and limits.
	config_string_limit (NBString def_val, size_t minl=0, size_t maxl=0, const char *name=NULL, const char *desc=NULL)
	Object constructor with limits.
config_string_limit &	operator= (const config_string &ci)
	Copy a config_string object into the config_string_limit.
config_string_limit &	operator= (const config_string_limit &cil)
	Copy one config_string_limit object to another.
Public Member Functions inherited from config_string
virtual void	GetTextValue (NBString &s) override
	Get the object value (as a text string with quotations) to the specified NBString object.
	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

A config_string with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI.

Constructor & Destructor Documentation

config_string_limit() [1/2]

config_string_limit::config_string_limit ( config_obj & owner, NBString def_val, size_t minl = 0, size_t maxl = 0, const char * name = NULL, const char * desc = NULL )

inline

Object constructor with the parent/owner leaf parameter and limits.

Parameters

owner	Reference to owner/parent leaf
def_val	Default value
minl	Minimum length
maxl	Maximum length
name	Field name assigned to the value
desc	Description used for info/tool tip

config_string_limit() [2/2]

config_string_limit::config_string_limit ( NBString def_val, size_t minl = 0, size_t maxl = 0, const char * name = NULL, const char * desc = NULL )

inline

Object constructor with limits.

Parameters

def_val	Default value
minl	Minimum length
maxl	Maximum length
name	Field name assigned to the value
desc	Description used for info/tool tip

Member Function Documentation

operator=() [1/2]

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

inline

Copy a config_string object into the config_string_limit.

Parameters

ci	Reference to a config_string object

operator=() [2/2]

config_string_limit & config_string_limit::operator= ( const config_string_limit & cil )

inline

Copy one config_string_limit object to another.

Parameters

cil	Reference to a config_string_limit object

---

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

• config_obj.h