NetBurner 3.5.0
PDF Version
 
config_value Class Referenceabstract

Base class used to create a configuration value. More...

#include <config_obj.h>

Inherits config_leaf.

Inherited by CUR_IPADDR4, Dynamic_IPADDR, config_IPADDR, config_IPADDR4, config_MACADR, config_bool, config_double, config_int, config_report, config_string, and config_uint.

Protected Member Functions

 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

Base class used to create a configuration value.

Base class that can be used to create custom configuration values in a JSON compatible format. The JSON compatible types are: integer, boolean, null, string, object or array.


The system already provides the common JSON value types, including: config_int, config_uint, config_bool, config_chooser, config_string, config_pass, config_IPADDR4, config_IPADDR, config_MACADR,

A config_obj can hold multiple values in a JSON object. A config_value holds only a single JSON value.

See also
config_obj

Constructor & Destructor Documentation

◆ config_value() [1/2]

config_value::config_value ( config_obj & owner,
const char * name,
const char * desc )
inlineprotected

Object constructor with the parent/owner leaf parameter.

For example,

myValue(config_obj &owner, const char *name, const char *desc = nullptr) : config_value(owner, name, desc){};
Base class used to create configuration objects.
Definition config_obj.h:277
Base class used to create a configuration value.
Definition config_obj.h:446
Parameters
ownerReference to owner/parent leaf
nameField name
descDescription used for info/tool tip

◆ config_value() [2/2]

config_value::config_value ( const char * name,
const char * desc )
inlineprotected

Object constructor.

This constructor should be called as part of the derived class constructor. For example,

myValue(const char *name, const char *desc = nullptr) : config_value(name, desc){}
Parameters
nameField name
descDescription used for info/tool tip

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