cConfigurationReader Class Reference¶
|
API
|
Classes | |
| class | KeyValue |
| Abstract base class for representing a key-value pair in the configuration. More... | |
Public Member Functions | |
| virtual | ~cConfigurationReader () |
| virtual void | initializeFrom (cConfiguration *bootConfig)=0 |
| virtual const char * | getFileName () const =0 |
| virtual const char * | getDefaultBaseDirectory () const =0 |
| virtual int | getNumSections () const =0 |
| virtual const char * | getSectionName (int sectionId) const =0 |
| virtual int | getNumEntries (int sectionId) const =0 |
| virtual const KeyValue & | getEntry (int sectionId, int entryId) const =0 |
| virtual void | dump () const =0 |
Description
Abstract base class for configuration readers for SectionBasedConfiguration.
This class presents configuration contents as key-value pairs grouped into sections. This class does not try to make sense of section/key names.
The default implementation is InifileReader, but other variants (e.g. those that read the configuration from a database) can also be implemented.
Constructor & Destructor Documentation
◆ ~cConfigurationReader()
|
inlinevirtual |
Virtual destructor
Member Function Documentation
◆ initializeFrom()
|
pure virtual |
Initializes the object from a "boot-time" configuration (omnetpp.ini). For example, if a particular cConfigurationReader class uses a database as data source, it may take the connection parameters from the "boot-time" configuration.
◆ getFileName()
|
pure virtual |
Returns the name of the configuration file. Returns nullptr if this object is not using a configuration file.
◆ getDefaultBaseDirectory()
|
pure virtual |
Returns the directory defaulted filenames should be understood to be relative to. For example, if the name of the output vector file is not explicitly configured, it defaults to "omnetpp.vec" in the default base directory.
◆ getNumSections()
|
pure virtual |
Returns the number of sections in the configuration.
◆ getSectionName()
|
pure virtual |
Returns the name of the given section. sectionId should be in 0..getNumSections()-1.
◆ getNumEntries()
|
pure virtual |
Returns the number of entries in the given section. sectionId should be in 0..getNumSections()-1.
◆ getEntry()
|
pure virtual |
Returns the given entry in the in the given section. sectionId should be in 0..getNumSections()-1. The lifetime of the returned entry may be limited, so references to entries should not be cached.
◆ dump()
|
pure virtual |
Prints the configuration to the standard output. This can be useful for tracking down problems.
Generated on for API by
1.14.0