Data keys parsed from a keyfile.
More...
#include <keydata.h>
|
keyvalue * | begin (void) const |
| Get first value object, for iterative examinations.
|
|
void | clear (const char *id) |
| Remove a keyword id from the keydata structure.
|
|
keyvalue * | end (void) const |
| Get last value object, for iterative examinations.
|
|
const char * | get (const char *id) const |
| Lookup a key value by it's id.
|
|
const char * | get (void) const |
| Get the name of this section.
|
|
const char * | operator() (const char *id) const |
| Lookup a key value by it's id.
|
|
void | set (const char *id, const char *value) |
| Set a keyword and value in the keydata structure.
|
|
void | delist (OrderedIndex *index) |
| Remove our ordered object from an existing index.
|
|
virtual void | enlist (OrderedIndex *index) |
| List our ordered object in default strategy mode.
|
|
void | enlistHead (OrderedIndex *index) |
| List our ordered object at start of a linked list on an index.
|
|
void | enlistTail (OrderedIndex *index) |
| List our ordered object at end of a linked list on an index.
|
|
OrderedObject * | getNext (void) const |
| Get next ordered member when iterating.
|
|
void | delist (LinkedObject **root) |
| Locate and remove ourselves from a list of objects.
|
|
void | enlist (LinkedObject **root) |
| Add our object to an existing linked list through a pointer.
|
|
LinkedObject * | getNext (void) const |
| Get next effective object when iterating.
|
|
bool | is_member (LinkedObject *list) const |
| Search to see if we are a member of a specific list.
|
|
virtual void | release (void) |
| Release list, mark as no longer linked.
|
|
virtual void | retain (void) |
| Retain by marking as self referenced list.
|
|
ObjectProtocol * | copy (void) |
| Retain (increase retention of) object when copying.
|
|
void | operator++ (void) |
| Increase retention operator.
|
|
void | operator-- (void) |
| Decrease retention operator.
|
|
virtual | ~ObjectProtocol () |
| Required virtual destructor.
|
|
Data keys parsed from a keyfile.
This is a specific [] section from a fully loaded keyfile, and offers common means to access data members. This is related to the original GNU Common C++ keydata object, although it is formed in a keyfile class which is loaded from a config file all at once.
- Author
- David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org
- Examples
- keydata.cpp.
Definition at line 58 of file keydata.h.
◆ pointer
Convenience typedef for iterative pointer.
Definition at line 151 of file keydata.h.
◆ begin()
keyvalue * ucommon::keydata::begin |
( |
void | | ) |
const |
|
inline |
Get first value object, for iterative examinations.
- Returns
- first key value in chain.
Definition at line 136 of file keydata.h.
◆ clear()
void ucommon::keydata::clear |
( |
const char * | id | ) |
|
Remove a keyword id from the keydata structure.
Removed items still use pager allocated memory.
- Parameters
-
◆ end()
keyvalue * ucommon::keydata::end |
( |
void | | ) |
const |
|
inline |
Get last value object, for iterative examinations.
- Returns
- first key value in chain.
Definition at line 144 of file keydata.h.
◆ get() [1/2]
const char * ucommon::keydata::get |
( |
const char * | id | ) |
const |
Lookup a key value by it's id.
- Parameters
-
- Returns
- value string or NULL if not found.
- Examples
- keydata.cpp.
◆ get() [2/2]
const char * ucommon::keydata::get |
( |
void | | ) |
const |
|
inline |
Get the name of this section.
Useful in iterative examinations.
- Returns
- name of keydata section.
Definition at line 128 of file keydata.h.
◆ operator()()
const char * ucommon::keydata::operator() |
( |
const char * | id | ) |
const |
|
inline |
Lookup a key value by it's id.
- Parameters
-
- Returns
- value string or NULL if not found.
Definition at line 104 of file keydata.h.
◆ set()
void ucommon::keydata::set |
( |
const char * | id, |
|
|
const char * | value ) |
Set a keyword and value in the keydata structure.
If the keyword already exists, it is replaced. Removed items still use pager allocated memory.
- Parameters
-
id | to set. |
value | for the id. |
◆ keyfile
◆ keyvalue
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/keydata.h