DataDirector API
Public Member Functions | List of all members
DDD_XMLConfigMgr Class Reference

Object that encapsulates XML loading and saving methods. More...

#include <DDD_XMLConfigMgr.h>

Inheritance diagram for DDD_XMLConfigMgr:
DDD_ProgressPublisher DDD_LogFacade

Public Member Functions

 DDD_XMLConfigMgr ()
 
virtual ~DDD_XMLConfigMgr ()
 
bool LoadXML (XMLConfigTarget *target, const char *xmlFile, bool readGUISettings=false)
 
bool SaveXML (XMLConfigTarget *target, const char *xmlFile, bool saveGUISettings=false)
 
- Public Member Functions inherited from DDD_ProgressPublisher
 DDD_ProgressPublisher ()
 
void SetProgressCallback (ProgressCallback callback)
 
void UpdateProgress (float percentage)
 

Additional Inherited Members

- Static Public Member Functions inherited from DDD_LogFacade
static void LogDebug (const char *format,...)
 
static void LogInfo (const char *format,...)
 
static void LogWarning (const char *format,...)
 
static void LogError (const char *format,...)
 
- Protected Attributes inherited from DDD_ProgressPublisher
ProgressCallback _progressCb
 
float _currentProgress
 

Detailed Description

Object that encapsulates XML loading and saving methods.

Constructor & Destructor Documentation

Constructor

virtual ~DDD_XMLConfigMgr ( )
virtual

Destructor

Member Function Documentation

bool LoadXML ( XMLConfigTarget target,
const char *  xmlFile,
bool  readGUISettings = false 
)

Populates target with data given by XML file

Parameters
targetTarget instance that is currently using this XMLConfigMgr
xmlFileFilename of XML file that is to be loaded.
readGUISettings(Optional) If Target has a GUI or contains a DDD_Viewer, this should be true.
Returns
true if configuration is successfully loaded, false otherwise.
bool SaveXML ( XMLConfigTarget target,
const char *  xmlFile,
bool  saveGUISettings = false 
)

Populates XML file with data given by target

Parameters
targetTarget instance that is currently using this XMLConfigMgr
xmlFileFilename of XML file that is to be saved.
readGUISettings(Optional) If Target has a GUI or contains a DDD_Viewer, this should be true.
Returns
true if configuration is successfully saved, false otherwise.

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