hydrogen 1.2.6
XMLDoc Class Reference

XMLDoc is a subclass of QDomDocument with read and write methods. More...

#include <Xml.h>

Inheritance diagram for XMLDoc:
Object< XMLDoc > Base

Public Member Functions

 XMLDoc ()
 basic constructor
 
bool read (const QString &filepath, bool bSilent=false)
 read the content of an xml file
 
XMLNode set_root (const QString &node_name, const QString &xmlns=nullptr)
 create the xml header and root node
 
bool write (const QString &filepath)
 write itself into a file
 
- Public Member Functions inherited from Object< XMLDoc >
 Object ()
 
 Object (const Object< XMLDoc > &other)
 
- Public Member Functions inherited from Base
 Base ()
 
 Base (const Base &other)
 
virtual const char * class_name () const
 
void logBacktrace () const
 Print the current stack at point into the debug log.
 
void Print (bool bShort=true) const
 Prints content of toQString() via DEBUGLOG.
 
virtual QString toQString (const QString &sPrefix="", bool bShort=true) const
 Formatted string version for debugging purposes.
 

Additional Inherited Members

- Static Public Member Functions inherited from Base
static const char * _class_name ()
 return the class name
 
static QString base_clock (const QString &sMsg)
 Measures the current time and stores it in __last_clock.
 
static QString base_clock_in (const QString &sMsg)
 
static int bootstrap (Logger *logger, bool count=false)
 must be called before any Object instantiation !
 
static bool count_active ()
 
static int getAliveObjectCount ()
 
static object_map_t getObjectMap ()
 
static Loggerlogger ()
 return the logger instance
 
static int objects_count ()
 
static void printObjectMapDiff (object_map_t map)
 Creates the difference between a snapshot of the object map and its current state and prints it to std::cout.
 
static void set_count (bool flag)
 enable/disable class instances counting
 
static void write_objects_map_to (std::ostream &out, object_map_t *map=nullptr)
 output the full objects map to a given ostream
 
static void write_objects_map_to_cerr ()
 output objects map to stderr
 
- Static Public Attributes inherited from Base
static QString sPrintIndention = " "
 String used to format the debugging string output of some core classes.
 
- Protected Member Functions inherited from Object< XMLDoc >
 ~Object ()
 
- Protected Member Functions inherited from Base
 ~Base ()
 
- Static Protected Member Functions inherited from Base
static void registerClass (const char *name, const atomic_obj_cpt_t *counters)
 
- Static Protected Attributes inherited from Base
static bool __count = false
 should we count class instances
 
static timeval __last_clock = { 0, 0 }
 
static Logger__logger = nullptr
 
static bool bLogColors = true
 

Detailed Description

XMLDoc is a subclass of QDomDocument with read and write methods.

Definition at line 181 of file Xml.h.

Constructor & Destructor Documentation

◆ XMLDoc()

XMLDoc ( )

basic constructor

Definition at line 275 of file Xml.cpp.

Member Function Documentation

◆ read()

bool read ( const QString & filepath,
bool bSilent = false )

read the content of an xml file

Parameters
filepaththe path to the file to read from
bSilentWhether debug and info messages should be logged when anomalies are encountered while reading the XML nodes.

Definition at line 277 of file Xml.cpp.

◆ set_root()

XMLNode set_root ( const QString & node_name,
const QString & xmlns = nullptr )

create the xml header and root node

Parameters
node_namethe name of the rootnode to build
xmlnsthe xml namespace prefix to add after XMLNS_BASE

Definition at line 336 of file Xml.cpp.

◆ write()

bool write ( const QString & filepath)

write itself into a file

Parameters
filepaththe path to the file to write to

Definition at line 311 of file Xml.cpp.