NetBurner 3.5.6
PDF Version
config_uint_limit Class Reference

A config_uint with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI. More...

#include <config_obj.h>

Inherits config_uint.

Public Member Functions

 config_uint_limit (config_obj &owner, uint32_t def_val, uint32_t minv=0, uint32_t maxv=UINT_MAX, const char *name=NULL, const char *desc=NULL)
 Object constructor with the parent/owner leaf parameter and limits.
 
 config_uint_limit (uint32_t def_val, uint32_t minv=0, uint32_t maxv=UINT_MAX, const char *name=NULL, const char *desc=NULL)
 Object constructor with limits.
 
config_uint_limitoperator= (const config_uint &ci)
 Copy a config_uint object into the config_uint_limit.
 
config_uint_limitoperator= (const config_uint_limit &cil)
 Copy one config_uint_limit object to another.
 
- Public Member Functions inherited from config_uint
virtual void GetTextValue (NBString &s) override
 Copy the object value to the specified NBString object.
 
 config_uint (config_obj &owner, uint32_t def_val, const char *name, const char *desc=NULL)
 Object constructor with the parent/owner leaf parameter.
 
 config_uint (uint32_t def_val, const char *name, const char *desc=NULL)
 Object constructor.
 
 operator uint32_t () const
 Return the object value.
 
config_uintoperator= (const uint32_t i)
 Assign the config_uint object value from a uint32_t value.
 
config_uintoperator= (const config_uint &ci)
 Copy one config_uint 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

A config_uint with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI.

Constructor & Destructor Documentation

◆ config_uint_limit() [1/2]

config_uint_limit::config_uint_limit ( config_obj & owner,
uint32_t def_val,
uint32_t minv = 0,
uint32_t maxv = UINT_MAX,
const char * name = NULL,
const char * desc = NULL )
inline

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

Parameters
ownerReference to owner/parent leaf
def_valDefault value
minvMinimum value
maxvMaximum value
nameField name assigned to the value
descDescription used for info/tool tip

◆ config_uint_limit() [2/2]

config_uint_limit::config_uint_limit ( uint32_t def_val,
uint32_t minv = 0,
uint32_t maxv = UINT_MAX,
const char * name = NULL,
const char * desc = NULL )
inline

Object constructor with limits.

Parameters
def_valDefault value
minvMinimum value
maxvMaximum value
nameField name assigned to the value
descDescription used for info/tool tip

Member Function Documentation

◆ operator=() [1/2]

config_uint_limit & config_uint_limit::operator= ( const config_uint & ci)
inline

Copy a config_uint object into the config_uint_limit.

Parameters
ciReference to a config_uint object

◆ operator=() [2/2]

config_uint_limit & config_uint_limit::operator= ( const config_uint_limit & cil)
inline

Copy one config_uint_limit object to another.

Parameters
cilReference to a config_uint_limit object

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