Class SBCSerializerXML#

#include <SBCSerializerXML.hpp>

Inherits the following classes: SBCSerializer

Public Functions#

Type	Name
	SBCSerializerXML (const std::string & fileName, bool write)
virtual bool	readBoolElement () Reads an element of boolean type.
virtual char *	readCharArrayElement (unsigned int & arraySize) Reads an element of char array type of size `arraySize` .
virtual char	readCharElement () Reads an element of char type.
virtual double	readDoubleElement () Reads an element of double type.
virtual void	readEndElement () Reads the end element.
virtual float	readFloatElement () Reads an element of float type.
virtual int	readIntElement () Reads an element of integer type.
virtual long	readLongElement () Reads an element of long integer type.
virtual long long	readLongLongElement () Reads an element of long long integer type.
virtual short	readShortElement () Reads an element of short integer type.
virtual void	readStartElement () Reads the start element.
virtual std::string	readStringElement () Reads an element of string type.
virtual std::string	readStringElementFromBase64 () Reads an element of string type in Base64 (supports html)
virtual SBCContainerUUID	readUUIDElement () Reads an element of UUID type.
virtual unsigned char	readUnsignedCharElement () Reads an element of unsigned char type.
virtual unsigned int	readUnsignedIntElement () Reads an element of unsigned integer type.
virtual unsigned long	readUnsignedLongElement () Reads an element of unsigned long integer type.
virtual unsigned long long	readUnsignedLongLongElement () Reads an element of unsigned long long integer type.
virtual unsigned short	readUnsignedShortElement () Reads an element of unsigned short integer type.
virtual void	writeBoolElement (const std::string & elementName, bool element) Writes an element of boolean type with `elementName` name and value`element` .
virtual void	writeCharArrayElement (const std::string & elementName, const char * elementArray, unsigned int arraySize) Writes an element of char array type with `elementName` name of size`arraySize` and values`elementArray` .
virtual void	writeCharElement (const std::string & elementName, char element) Writes an element of char type with `elementName` name and value`element` .
virtual void	writeDoubleElement (const std::string & elementName, double element) Writes an element of double type with `elementName` name and value`element` .
virtual void	writeEndElement () Writes the end element.
virtual void	writeFloatElement (const std::string & elementName, float element) Writes an element of float type with `elementName` name and value`element` .
virtual void	writeIntElement (const std::string & elementName, int element) Writes an element of integer type with `elementName` name and value`element` .
virtual void	writeLongElement (const std::string & elementName, long element) Writes an element of long integer type with `elementName` name and value`element` .
virtual void	writeLongLongElement (const std::string & elementName, long long element) Writes an element of long long integer type with `elementName` name and value`element` .
virtual void	writeShortElement (const std::string & elementName, short element) Writes an element of short integer type with `elementName` name and value`element` .
virtual void	writeStartElement (const std::string & elementName) Writes the start element with `elementName` name.
virtual void	writeStringElement (const std::string & elementName, const std::string & element) Writes an element of string type with `elementName` name and value`element` .
virtual void	writeStringElementInBase64 (const std::string & elementName, const std::string & element) Writes an element of string type in Base64 (supports html) with `elementName` name and value`element` .
virtual void	writeUUIDElement (const std::string & elementName, const SBCContainerUUID & element) Writes an element of UUID type with `elementName` name and value`element` .
virtual void	writeUnsignedCharElement (const std::string & elementName, unsigned char element) Writes an element of unsigned char type with `elementName` name and value`element` .
virtual void	writeUnsignedIntElement (const std::string & elementName, unsigned int element) Writes an element of unsigned integer type with `elementName` name and value`element` .
virtual void	writeUnsignedLongElement (const std::string & elementName, unsigned long element) Writes an element of unsigned long integer type with `elementName` name and value`element` .
virtual void	writeUnsignedLongLongElement (const std::string & elementName, unsigned long long element) Writes an element of unsigned long long integer type with `elementName` name and value`element` .
virtual void	writeUnsignedShortElement (const std::string & elementName, unsigned short element) Writes an element of unsigned short integer type with `elementName` name and value`element` .
virtual	~SBCSerializerXML ()

Public Functions inherited from SBCSerializer#

See SBCSerializer

Type	Name
	SBCSerializer ()
virtual bool	readBoolElement () Reads an element of boolean type.
virtual char *	readCharArrayElement (unsigned int & arraySize) Reads an element of char array type of size `arraySize` .
virtual char	readCharElement () Reads an element of char type.
virtual double	readDoubleElement () Reads an element of double type.
virtual void	readEndElement () Reads the end element.
virtual float	readFloatElement () Reads an element of float type.
virtual int	readIntElement () Reads an element of integer type.
virtual long	readLongElement () Reads an element of long integer type.
virtual long long	readLongLongElement () Reads an element of long long integer type.
virtual short	readShortElement () Reads an element of short integer type.
virtual void	readStartElement () Reads the start element.
virtual std::string	readStringElement () Reads an element of string type.
virtual std::string	readStringElementFromBase64 () Reads an element of string type in Base64 (supports html)
virtual SBCContainerUUID	readUUIDElement () Reads an element of UUID type.
virtual unsigned char	readUnsignedCharElement () Reads an element of unsigned char type.
virtual unsigned int	readUnsignedIntElement () Reads an element of unsigned integer type.
virtual unsigned long	readUnsignedLongElement () Reads an element of unsigned long integer type.
virtual unsigned long long	readUnsignedLongLongElement () Reads an element of unsigned long long integer type.
virtual unsigned short	readUnsignedShortElement () Reads an element of unsigned short integer type.
virtual void	writeBoolElement (const std::string & elementName, bool element) Writes an element of boolean type with `elementName` name and value`element` .
virtual void	writeCharArrayElement (const std::string & elementName, const char * elementArray, unsigned int arraySize) Writes an element of char array type with `elementName` name of size`arraySize` and values`elementArray` .
virtual void	writeCharElement (const std::string & elementName, char element) Writes an element of char type with `elementName` name and value`element` .
virtual void	writeDoubleElement (const std::string & elementName, double element) Writes an element of double type with `elementName` name and value`element` .
virtual void	writeEndElement () Writes the end element.
virtual void	writeFloatElement (const std::string & elementName, float element) Writes an element of float type with `elementName` name and value`element` .
virtual void	writeIntElement (const std::string & elementName, int element) Writes an element of integer type with `elementName` name and value`element` .
virtual void	writeLongElement (const std::string & elementName, long element) Writes an element of long integer type with `elementName` name and value`element` .
virtual void	writeLongLongElement (const std::string & elementName, long long element) Writes an element of long long integer type with `elementName` name and value`element` .
virtual void	writeShortElement (const std::string & elementName, short element) Writes an element of short integer type with `elementName` name and value`element` .
virtual void	writeStartElement (const std::string & elementName) Writes the start element with `elementName` name.
virtual void	writeStringElement (const std::string & elementName, const std::string & element) Writes an element of string type with `elementName` name and value`element` .
virtual void	writeStringElementInBase64 (const std::string & elementName, const std::string & element) Writes an element of string type in Base64 (supports html) with `elementName` name and value`element` .
virtual void	writeUUIDElement (const std::string & elementName, const SBCContainerUUID & element) Writes an element of UUID type with `elementName` name and value`element` .
virtual void	writeUnsignedCharElement (const std::string & elementName, unsigned char element) Writes an element of unsigned char type with `elementName` name and value`element` .
virtual void	writeUnsignedIntElement (const std::string & elementName, unsigned int element) Writes an element of unsigned integer type with `elementName` name and value`element` .
virtual void	writeUnsignedLongElement (const std::string & elementName, unsigned long element) Writes an element of unsigned long integer type with `elementName` name and value`element` .
virtual void	writeUnsignedLongLongElement (const std::string & elementName, unsigned long long element) Writes an element of unsigned long long integer type with `elementName` name and value`element` .
virtual void	writeUnsignedShortElement (const std::string & elementName, unsigned short element) Writes an element of unsigned short integer type with `elementName` name and value`element` .
virtual	~SBCSerializer ()

Detailed Description#

This class describes an XML serializer

Short name: SBSerializerXML

Public Functions Documentation#

function SBCSerializerXML#

SBCSerializerXML::SBCSerializerXML (
    const std::string & fileName,
    bool write
)

function readBoolElement#

Reads an element of boolean type.

virtual bool SBCSerializerXML::readBoolElement ()

Implements SBCSerializer::readBoolElement

function readCharArrayElement#

Reads an element of char array type of size arraySize .

virtual char * SBCSerializerXML::readCharArrayElement (
    unsigned int & arraySize
)

Implements SBCSerializer::readCharArrayElement

function readCharElement#

Reads an element of char type.

virtual char SBCSerializerXML::readCharElement ()

Implements SBCSerializer::readCharElement

function readDoubleElement#

Reads an element of double type.

virtual double SBCSerializerXML::readDoubleElement ()

Implements SBCSerializer::readDoubleElement

function readEndElement#

Reads the end element.

virtual void SBCSerializerXML::readEndElement ()

Implements SBCSerializer::readEndElement

function readFloatElement#

Reads an element of float type.

virtual float SBCSerializerXML::readFloatElement ()

Implements SBCSerializer::readFloatElement

function readIntElement#

Reads an element of integer type.

virtual int SBCSerializerXML::readIntElement ()

Implements SBCSerializer::readIntElement

function readLongElement#

Reads an element of long integer type.

virtual long SBCSerializerXML::readLongElement ()

Note: because the size of longs may vary between platforms (e.g. 4 bytes on Windows and 8 bytes on OS X), it is advised not to use this function when portability is required.

Implements SBCSerializer::readLongElement

function readLongLongElement#

Reads an element of long long integer type.

virtual long long SBCSerializerXML::readLongLongElement ()

Implements SBCSerializer::readLongLongElement

function readShortElement#

Reads an element of short integer type.

virtual short SBCSerializerXML::readShortElement ()

Implements SBCSerializer::readShortElement

function readStartElement#

Reads the start element.

virtual void SBCSerializerXML::readStartElement ()

Implements SBCSerializer::readStartElement

function readStringElement#

Reads an element of string type.

virtual std::string SBCSerializerXML::readStringElement ()

Implements SBCSerializer::readStringElement

function readStringElementFromBase64#

Reads an element of string type in Base64 (supports html)

virtual std::string SBCSerializerXML::readStringElementFromBase64 ()

Implements SBCSerializer::readStringElementFromBase64

function readUUIDElement#

Reads an element of UUID type.

virtual SBCContainerUUID SBCSerializerXML::readUUIDElement ()

Implements SBCSerializer::readUUIDElement

function readUnsignedCharElement#

Reads an element of unsigned char type.

virtual unsigned char SBCSerializerXML::readUnsignedCharElement ()

Implements SBCSerializer::readUnsignedCharElement

function readUnsignedIntElement#

Reads an element of unsigned integer type.

virtual unsigned int SBCSerializerXML::readUnsignedIntElement ()

Implements SBCSerializer::readUnsignedIntElement

function readUnsignedLongElement#

Reads an element of unsigned long integer type.

virtual unsigned long SBCSerializerXML::readUnsignedLongElement ()

Note: because the size of longs may vary between platforms (e.g. 4 bytes on Windows and 8 bytes on OS X), it is advised not to use this function when portability is required.

Implements SBCSerializer::readUnsignedLongElement

function readUnsignedLongLongElement#

Reads an element of unsigned long long integer type.

virtual unsigned long long SBCSerializerXML::readUnsignedLongLongElement ()

Implements SBCSerializer::readUnsignedLongLongElement

function readUnsignedShortElement#

Reads an element of unsigned short integer type.

virtual unsigned short SBCSerializerXML::readUnsignedShortElement ()

Implements SBCSerializer::readUnsignedShortElement

function writeBoolElement#

Writes an element of boolean type with elementName name and valueelement .

virtual void SBCSerializerXML::writeBoolElement (
    const std::string & elementName,
    bool element
)

Implements SBCSerializer::writeBoolElement

function writeCharArrayElement#

Writes an element of char array type with elementName name of sizearraySize and valueselementArray .

virtual void SBCSerializerXML::writeCharArrayElement (
    const std::string & elementName,
    const char * elementArray,
    unsigned int arraySize
)

Implements SBCSerializer::writeCharArrayElement

function writeCharElement#

Writes an element of char type with elementName name and valueelement .

virtual void SBCSerializerXML::writeCharElement (
    const std::string & elementName,
    char element
)

Implements SBCSerializer::writeCharElement

function writeDoubleElement#

Writes an element of double type with elementName name and valueelement .

virtual void SBCSerializerXML::writeDoubleElement (
    const std::string & elementName,
    double element
)

Implements SBCSerializer::writeDoubleElement

function writeEndElement#

Writes the end element.

virtual void SBCSerializerXML::writeEndElement ()

Implements SBCSerializer::writeEndElement

function writeFloatElement#

Writes an element of float type with elementName name and valueelement .

virtual void SBCSerializerXML::writeFloatElement (
    const std::string & elementName,
    float element
)

Implements SBCSerializer::writeFloatElement

function writeIntElement#

Writes an element of integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeIntElement (
    const std::string & elementName,
    int element
)

Implements SBCSerializer::writeIntElement

function writeLongElement#

Writes an element of long integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeLongElement (
    const std::string & elementName,
    long element
)

Note: because the size of longs may vary between platforms (e.g. 4 bytes on Windows and 8 bytes on OS X), it is advised not to use this function when portability is required.

Implements SBCSerializer::writeLongElement

function writeLongLongElement#

Writes an element of long long integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeLongLongElement (
    const std::string & elementName,
    long long element
)

Implements SBCSerializer::writeLongLongElement

function writeShortElement#

Writes an element of short integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeShortElement (
    const std::string & elementName,
    short element
)

Implements SBCSerializer::writeShortElement

function writeStartElement#

Writes the start element with elementName name.

virtual void SBCSerializerXML::writeStartElement (
    const std::string & elementName
)

Implements SBCSerializer::writeStartElement

function writeStringElement#

Writes an element of string type with elementName name and valueelement .

virtual void SBCSerializerXML::writeStringElement (
    const std::string & elementName,
    const std::string & element
)

Implements SBCSerializer::writeStringElement

function writeStringElementInBase64#

Writes an element of string type in Base64 (supports html) with elementName name and valueelement .

virtual void SBCSerializerXML::writeStringElementInBase64 (
    const std::string & elementName,
    const std::string & element
)

Implements SBCSerializer::writeStringElementInBase64

function writeUUIDElement#

Writes an element of UUID type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUUIDElement (
    const std::string & elementName,
    const SBCContainerUUID & element
)

Implements SBCSerializer::writeUUIDElement

function writeUnsignedCharElement#

Writes an element of unsigned char type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUnsignedCharElement (
    const std::string & elementName,
    unsigned char element
)

Implements SBCSerializer::writeUnsignedCharElement

function writeUnsignedIntElement#

Writes an element of unsigned integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUnsignedIntElement (
    const std::string & elementName,
    unsigned int element
)

Implements SBCSerializer::writeUnsignedIntElement

function writeUnsignedLongElement#

Writes an element of unsigned long integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUnsignedLongElement (
    const std::string & elementName,
    unsigned long element
)

Note: because the size of longs may vary between platforms (e.g. 4 bytes on Windows and 8 bytes on OS X), it is advised not to use this function when portability is required.

Implements SBCSerializer::writeUnsignedLongElement

function writeUnsignedLongLongElement#

Writes an element of unsigned long long integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUnsignedLongLongElement (
    const std::string & elementName,
    unsigned long long element
)

Implements SBCSerializer::writeUnsignedLongLongElement

function writeUnsignedShortElement#

Writes an element of unsigned short integer type with elementName name and valueelement .

virtual void SBCSerializerXML::writeUnsignedShortElement (
    const std::string & elementName,
    unsigned short element
)

Implements SBCSerializer::writeUnsignedShortElement

function ~SBCSerializerXML#

virtual SBCSerializerXML::~SBCSerializerXML ()