EPICS ARCHIVER V4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | Public Attributes | List of all members
IndexConfig Class Reference

The index configuration is used by both the ArchiveIndexTool and the simple file-by-file mechanism supported by the ListedIndex. More...

#include <IndexConfig.h>

Public Member Functions

bool parse (const stdString &config_name)
 Parse the given configuration file. More...
 

Public Attributes

stdList< stdString > subarchives
 List of sub-archives found in the indexconfig file. More...
 

Detailed Description

The index configuration is used by both the ArchiveIndexTool and the simple file-by-file mechanism supported by the ListedIndex.

Parser for indexconfig.dtd.

Member Function Documentation

bool IndexConfig::parse ( const stdString &  config_name)

Parse the given configuration file.

Since the ListIndex might use this config file as well as a "real" binary index file, some care is taken in here to assert that we're really dealing with a config. file and not a binary index file.

Returns
true if the file exists and parses OK. false if the file exists but is no XML file, so it can't possibly be an index config.
Exceptions
ThrowsGenericException in case the file cannot be opened at all or there is an XML error while parsing it as an indexconfig.

Member Data Documentation

stdList<stdString> IndexConfig::subarchives

List of sub-archives found in the indexconfig file.

Only valid after parse succeeds.


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