OmgSerialisable Class Reference
[Library]

#include <omgserialisable.h>

Inheritance diagram for OmgSerialisable:

[legend]List of all members.

---

Detailed Description

An abstract base class for any class that is serialiseable to xml.

Author:

Tim Sutton

Definition at line 28 of file omgserialisable.h.

Public Member Functions
	OmgSerialisable ()
virtual	~OmgSerialisable ()
virtual QString	toXml () const =0
virtual bool	toXml (QString theFileName) const
virtual bool	fromXml (const QString theXml)=0
virtual bool	fromXmlFile (const QString theFileName)

---

Constructor & Destructor Documentation

OmgSerialisable::OmgSerialisable (   )

Constructor . Definition at line 23 of file omgserialisable.cpp.

OmgSerialisable::~OmgSerialisable (   )  [virtual]

Desctructor . Definition at line 26 of file omgserialisable.cpp.

---

Member Function Documentation

virtual bool OmgSerialisable::fromXml (  const QString  theXml  )  [pure virtual]

Read this object from xml and return result as true for success, false for failure (virtual). Implemented in OmgAlgorithm, OmgAlgorithmParameter, OmgExperiment, OmgLayer, and OmgModel. Referenced by fromXmlFile().

bool OmgSerialisable::fromXmlFile (  const QString  theFileName  )  [virtual]

Read this object from xml in a file and return result as true for success, false for failure. Internally it uses fromXml(QString) method above so that must be properly implemented. Definition at line 49 of file omgserialisable.cpp. References fromXml(). Referenced by Omgui::getAvailableLayerSets(), OmgAlgorithmSet::loadAlgorithms(), OmgExperimentTest::loadAndGraph(), OmgLayerSetManager::on_pbnImport_clicked(), OmgExperimentSelector::on_pbnOK_clicked(), OmgLayerSetManager::on_toolCopy_clicked(), OmgLocalitiesModelTest::rowsAndColumns(), OmgModelTest::run(), OmgExperimentTest::run(), OmgExerimentPrinterTest::run(), OmgExperimentTest::saveAndLoadExperiment(), OmgModelTest::saveAndLoadModel(), and OmgLayerSetManager::selectLayerSet().

Here is the call graph for this function:

bool OmgSerialisable::toXml (  QString  theFileName  )  const [virtual]

Write this object to xml and return result as qstring (virtual). We provide a basic default implementation where given a file name, we will write the serialised xml to that file. Internally it uses toXml() method above so that must be properly implemented. Definition at line 29 of file omgserialisable.cpp. References toXml().

Here is the call graph for this function:

virtual QString OmgSerialisable::toXml (   )  const [pure virtual]

Write this object to xml and return result as qstring (virtual) . Implemented in OmgAlgorithm, OmgAlgorithmParameter, OmgAlgorithmSet, OmgExperiment, OmgLayer, OmgLayerSet, and OmgModel. Referenced by toXml().

---

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

• lib/omgserialisable.h
• lib/omgserialisable.cpp

---