DDAS::XMLSettingsReader Class Reference

#include <XMLSettingsReader.h>

Inheritance diagram for DDAS::XMLSettingsReader:

Public Member Functions
	XMLSettingsReader (const char *filename)
virtual	~XMLSettingsReader ()
virtual DDAS::ModuleSettings	get ()

Detailed Description

This class is a settings reader that can read XML Setings files. Two types of settings files can be read:

• Individual module settings files - these contain settings for a specific module. They have a <Module>/</Module> structure.
• Create settings files - These contain setings for a several modules, typically a single crate worth of modules. These have a <Crate></Crate> structure.

For the structure of module files see XMLSettingsWriter.h and its description of the XMLSettingsWriter class. The structure of Crate definition files is pretty simple:

<Crate> <Module id="n' fileref="path-to-module-file" /> ... </Crate>

That is for each module, in the crate, there's a module tag that specifies the module id (numbered from 0) and a reference to the XML module file that configures that module.

Constructor & Destructor Documentation

DDAS::XMLSettingsReader::XMLSettingsReader

(

const char *

file

)

constructor Save the module file for later.

Parameters

filename

- name of the XML file to process.

DDAS::XMLSettingsReader::~XMLSettingsReader ( )

virtual

destructor Just kill off the documents in m_modules

Member Function Documentation

ModuleSettings DDAS::XMLSettingsReader::get ( )

virtual

get Return the module settings for all of the documents stored. The first element of the pair in m_modules will be substituted into the s_modId field overriding the value in the XML.

Returns

std::vector<ModuleSettings> - the settings.

Implements DDAS::SettingsReader.

---

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

• xml/XMLSettingsReader.h
• xml/XMLSettingsReader.cpp