config_time_t Class Reference

Class to hold time configuration. More...

#include <config_time.h>

Inherits config_string.

Public Member Functions
	config_time_t (config_obj &owner, time_t def_val, const char *name, const char *desc=NULL, bool bUserSeesGmt=false)
	Object constructor with the parent/owner leaf parameter.
	config_time_t (config_obj &owner, const char *def_val, const char *name, const char *desc=NULL, bool bUserSeesGmt=false)
	Object constructor with the parent/owner leaf parameter.
	config_time_t (const char *def_val, const char *name, const char *desc=NULL, bool bUserSeesGmt=false)
	Object constructor.
	config_time_t (time_t def_val, const char *name, const char *desc=NULL)
	Object constructor.
virtual void	GetTypeValue (NBString &s)
	operator time_t () const
config_time_t &	operator= (time_t t)
	Assign the config_time_t object value from a anotherNBString object.
config_time_t &	operator= (const config_time_t &ci)
	Copy one config_string object to another.
NBString	GetAsGmtString ()
NBString	GetAsLocalString ()
virtual int	Missing_ConfigEndMarker (void *&startp)
	This is named so error messages make sense to user, old name was GetExtent.
void	RenderValue (int fd, int len, const char *extra)
void	RenderInput (int fd, int len, const char *extra)
bool	ProcessValue (const char *pValue)
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.

Static Public Member Functions
static NBString	TimetoNBString (time_t tv, bool bUtc=true)
static time_t	ParseTime (const char *cp, bool bUtc=true)
static time_t	ParseTime (NBString &ns, bool bUtc=true)

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

Class to hold time configuration.

Constructor & Destructor Documentation

config_time_t() [1/4]

config_time_t::config_time_t ( config_obj & owner, time_t def_val, const char * name, const char * desc = NULL, bool bUserSeesGmt = false )

inline

Object constructor with the parent/owner leaf parameter.

Default value assigned with a time_t

Parameters

owner	Reference to owner/parent leaf
def_val	Default value of type time_t
name	Field name assigned to the value
desc	Description used for info/tool tip
bUserSeesGmt	If true, the user sees GMT time when displaying/reading time values. If false, localtime is used.

config_time_t() [2/4]

config_time_t::config_time_t ( config_obj & owner, const char * def_val, const char * name, const char * desc = NULL, bool bUserSeesGmt = false )

inline

Object constructor with the parent/owner leaf parameter.

Default value assigned with a time_t

Parameters

owner	Reference to owner/parent leaf
def_val	Default value of type time_t
name	Field name assigned to the value
desc	Description used for info/tool tip
bUserSeesGmt	If true, the user sees GMT time when displaying/reading time values. If false, localtime is used.

config_time_t() [3/4]

config_time_t::config_time_t ( const char * def_val, const char * name, const char * desc = NULL, bool bUserSeesGmt = false )

inline

Object constructor.

Default value assigned with a time_t

Parameters

def_val	Default value of type time_t
name	Field name assigned to the value
desc	Description used for info/tool tip
bUserSeesGmt	If true, the user sees GMT time when displaying/reading time values. If false, localtime is used.

config_time_t() [4/4]

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

inline

Object constructor.

Parameters

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

Member Function Documentation

operator time_t()

config_time_t::operator time_t ( ) const

inline

Return the object value

Returns

The value of the object as a time_t

operator=() [1/2]

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

inline

Copy one config_string object to another.

Parameters

ci	Reference to a config_string object

operator=() [2/2]

config_time_t & config_time_t::operator= ( time_t t )

inline

Assign the config_time_t object value from a anotherNBString object.

Parameters

t

time_t

---

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

• config_time.h