feisty meow concerns codebase  2.140
configurable Class Referenceabstract

#include <configurable.h>

Inheritance diagram for configurable:
Collaboration diagram for configurable:

Public Member Functions

virtual ~configurable ()
 
 DEFINE_CLASS_NAME ("configurable")
 
virtual void get_config (configuration_list &to_fill, bool append) const =0
 interprets the contents of this object as a configuration list. More...
 
virtual bool set_config (const configuration_list &to_use)=0
 retrieves the config items from "to_use" and stores them here. More...
 

Detailed Description

Definition at line 35 of file configurable.h.

Constructor & Destructor Documentation

◆ ~configurable()

virtual configurable::~configurable ( )
inlinevirtual

Definition at line 38 of file configurable.h.

Member Function Documentation

◆ DEFINE_CLASS_NAME()

configurable::DEFINE_CLASS_NAME ( "configurable"  )

◆ get_config()

virtual void configurable::get_config ( configuration_list &  to_fill,
bool  append 
) const
pure virtual

interprets the contents of this object as a configuration list.

the list of configlets can be stored in any configurator object. if the "append" flag is true, then the list is added to. otherwise it is cleared first. this method can also be used to retrieve the configlets that this class defines as its configuration interface. that list can then be filled in using a configurator and passed to set_config().

◆ set_config()

virtual bool configurable::set_config ( const configuration_list &  to_use)
pure virtual

retrieves the config items from "to_use" and stores them here.

false is returned if any of the key items are missing or if the new key cannot be decoded.


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