eXperiment robotics framework

Serializable Class Reference
[Xml]

Those who inherit from this class can be serialized to xml. More...

#include <erf/erf_xml.hpp>>

Inheritance diagram for Serializable:

Inheritance graph
[legend]
Collaboration diagram for Serializable:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void save (XE *xe_out=0)
 updates xml data.
virtual void load (const XE *xe_in=0)
 updates the program variables associated to the xml.
 Serializable (XE *x=0)
virtual ~Serializable ()

Public Attributes

XExe
 the xml element.


Detailed Description

Those who inherit from this class can be serialized to xml.

Todo:
add findOrAdd or preLoad/preSave that are conditions common to all load and save requests

Definition at line 105 of file erf_xml.hpp.


Constructor & Destructor Documentation

Serializable::Serializable ( XE x = 0  )  [inline]

Definition at line 121 of file erf_xml.hpp.

virtual Serializable::~Serializable (  )  [inline, virtual]

Todo:
should the xe be deleted somehow ?

Definition at line 123 of file erf_xml.hpp.


Member Function Documentation

virtual void Serializable::save ( XE xe_out = 0  )  [inline, virtual]

updates xml data.

Does not write to disk, only updates the output with the current xml data. If no output is specified it means to update the own xe with the program variables

Parameters:
xe_out it can update the xe or output to an xe_out.

Reimplemented in ImageLoaderPlugin, LatexPlugin, ManagerTagsPlugin, and ZonePlugin.

Definition at line 113 of file erf_xml.hpp.

virtual void Serializable::load ( const XE xe_in = 0  )  [inline, virtual]

updates the program variables associated to the xml.

If input is given use that input, if not just read the values from the xe.

Parameters:
xe_in xml to read input from

Reimplemented in ManagerTagsPlugin.

Definition at line 119 of file erf_xml.hpp.


Member Data Documentation

the xml element.

Definition at line 108 of file erf_xml.hpp.


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

The miarn project - written by Joao Xavier