NetBurner 3.5.0
PDF Version
 
config_localname Class Reference

Configure device network name. More...

#include <config_netobj.h>

Inherits config_string.

Public Member Functions

 config_localname (config_obj &owner, NBString def_val, const char *name, const char *desc=NULL)
 Object constructor with the parent/owner leaf parameter.
 
 config_localname (NBString def_val, const char *name, const char *desc=NULL)
 Object constructor.
 
 config_localname (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL)
 Object constructor with the parent/owner leaf parameter.
 
 config_localname (const char *def_val, const char *name, const char *desc=NULL)
 Object constructor.
 
 operator NBString () const
 Returns the object value.
 
config_localnameoperator= (const char *p)
 Assign the config_localname object value from a const char* value.
 
config_localnameoperator= (const NBString &s)
 Assign the config_localname object value from a NBString object.
 
config_localnameoperator= (const config_string &ci)
 Copy a config_string object to a config_localname object.
 
config_localnameoperator= (const config_localname &ci)
 Copy one config_localname object to another.
 
- Public Member Functions inherited from config_string
virtual void GetTextValue (NBString &s)
 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_stringoperator= (const char *p)
 Assign the config_string object value from a const char* string.
 
config_stringoperator= (const NBString &s)
 Assign the config_string object value from a NBString object.
 
config_stringoperator= (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)
 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

Configure device network name.

Constructor & Destructor Documentation

◆ config_localname() [1/4]

config_localname::config_localname ( 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
ownerReference to owner/parent leaf
def_valDefault value of type NBString
nameField name assigned to the value
descDescription used for info/tool tip

◆ config_localname() [2/4]

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

Object constructor.

Default value is assigned with a NBString

Parameters
def_valDefault value of type NBString
nameField name assigned to the value
descDescription used for info/tool tip

◆ config_localname() [3/4]

config_localname::config_localname ( 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
ownerReference to owner/parent leaf
def_valDefault value of type char *
nameField name assigned to the value
descDescription used for info/tool tip

◆ config_localname() [4/4]

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

Object constructor.

Default value is assigned with a character string

Parameters
def_valDefault value of type char *
nameField name assigned to the value
descDescription used for info/tool tip

Member Function Documentation

◆ operator NBString()

config_localname::operator NBString ( ) const
inline

Returns the object value.

Returns
The value of the object as a NBString

◆ operator=() [1/4]

config_localname & config_localname::operator= ( const char * p)
inline

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

Parameters
pString to assign

◆ operator=() [2/4]

config_localname & config_localname::operator= ( const config_localname & ci)
inline

Copy one config_localname object to another.

Parameters
ciReference to a config_localname object

◆ operator=() [3/4]

config_localname & config_localname::operator= ( const config_string & ci)
inline

Copy a config_string object to a config_localname object.

Parameters
ciReference to a config_string object

◆ operator=() [4/4]

config_localname & config_localname::operator= ( const NBString & s)
inline

Assign the config_localname object value from a NBString object.

Parameters
sReference to a NBString object

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