Class SBCSerializer

ClassList > SBCSerializer

More...

• #include <SBCSerializer.hpp>

Inherited by the following classes: SBCSerializerBinary, SBCSerializerMemory, SBCSerializerXML

Public Functions

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 valueelement .
virtual void	writeCharArrayElement (const std::string & elementName, const char * elementArray, unsigned int arraySize) Writes an element of char array type with elementName name of sizearraySize and valueselementArray .
virtual void	writeCharElement (const std::string & elementName, char element) Writes an element of char type with elementName name and valueelement .
virtual void	writeDoubleElement (const std::string & elementName, double element) Writes an element of double type with elementName name and valueelement .
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 valueelement .
virtual void	writeIntElement (const std::string & elementName, int element) Writes an element of integer type with elementName name and valueelement .
virtual void	writeLongElement (const std::string & elementName, long element) Writes an element of long integer type with elementName name and valueelement .
virtual void	writeLongLongElement (const std::string & elementName, long long element) Writes an element of long long integer type with elementName name and valueelement .
virtual void	writeShortElement (const std::string & elementName, short element) Writes an element of short integer type with elementName name and valueelement .
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 valueelement .
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 valueelement .
virtual void	writeUUIDElement (const std::string & elementName, const SBCContainerUUID & element) Writes an element of UUID type with elementName name and valueelement .
virtual void	writeUnsignedCharElement (const std::string & elementName, unsigned char element) Writes an element of unsigned char type with elementName name and valueelement .
virtual void	writeUnsignedIntElement (const std::string & elementName, unsigned int element) Writes an element of unsigned integer type with elementName name and valueelement .
virtual void	writeUnsignedLongElement (const std::string & elementName, unsigned long element) Writes an element of unsigned long integer type with elementName name and valueelement .
virtual void	writeUnsignedLongLongElement (const std::string & elementName, unsigned long long element) Writes an element of unsigned long long integer type with elementName name and valueelement .
virtual void	writeUnsignedShortElement (const std::string & elementName, unsigned short element) Writes an element of unsigned short integer type with elementName name and valueelement .
virtual	~SBCSerializer ()

Detailed Description

This class is the base class for serializers

Short name: SBSerializer

Public Functions Documentation

function SBCSerializer

SBCSerializer::SBCSerializer () 

---

function readBoolElement

Reads an element of boolean type.

virtual bool SBCSerializer::readBoolElement () 

---

function readCharArrayElement

Reads an element of char array type of size arraySize .

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

---

function readCharElement

Reads an element of char type.

virtual char SBCSerializer::readCharElement () 

---

function readDoubleElement

Reads an element of double type.

virtual double SBCSerializer::readDoubleElement () 

---

function readEndElement

Reads the end element.

virtual void SBCSerializer::readEndElement () 

---

function readFloatElement

Reads an element of float type.

virtual float SBCSerializer::readFloatElement () 

---

function readIntElement

Reads an element of integer type.

virtual int SBCSerializer::readIntElement () 

---

function readLongElement

Reads an element of long integer type.

virtual long SBCSerializer::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.

---

function readLongLongElement

Reads an element of long long integer type.

virtual long long SBCSerializer::readLongLongElement () 

---

function readShortElement

Reads an element of short integer type.

virtual short SBCSerializer::readShortElement () 

---

function readStartElement

Reads the start element.

virtual void SBCSerializer::readStartElement () 

---

function readStringElement

Reads an element of string type.

virtual std::string SBCSerializer::readStringElement () 

---

function readStringElementFromBase64

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

virtual std::string SBCSerializer::readStringElementFromBase64 () 

---

function readUUIDElement

Reads an element of UUID type.

virtual SBCContainerUUID SBCSerializer::readUUIDElement () 

---

function readUnsignedCharElement

Reads an element of unsigned char type.

virtual unsigned char SBCSerializer::readUnsignedCharElement () 

---

function readUnsignedIntElement

Reads an element of unsigned integer type.

virtual unsigned int SBCSerializer::readUnsignedIntElement () 

---

function readUnsignedLongElement

Reads an element of unsigned long integer type.

virtual unsigned long SBCSerializer::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.

---

function readUnsignedLongLongElement

Reads an element of unsigned long long integer type.

virtual unsigned long long SBCSerializer::readUnsignedLongLongElement () 

---

function readUnsignedShortElement

Reads an element of unsigned short integer type.

virtual unsigned short SBCSerializer::readUnsignedShortElement () 

---

function writeBoolElement

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

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

---

function writeCharArrayElement

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

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

---

function writeCharElement

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

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

---

function writeDoubleElement

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

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

---

function writeEndElement

Writes the end element.

virtual void SBCSerializer::writeEndElement () 

---

function writeFloatElement

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

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

---

function writeIntElement

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

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

---

function writeLongElement

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

virtual void SBCSerializer::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.

---

function writeLongLongElement

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

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

---

function writeShortElement

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

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

---

function writeStartElement

Writes the start element with elementName name.

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

---

function writeStringElement

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

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

---

function writeStringElementInBase64

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

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

---

function writeUUIDElement

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

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

---

function writeUnsignedCharElement

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

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

---

function writeUnsignedIntElement

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

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

---

function writeUnsignedLongElement

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

virtual void SBCSerializer::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.

---

function writeUnsignedLongLongElement

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

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

---

function writeUnsignedShortElement

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

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

---

function ~SBCSerializer

virtual SBCSerializer::~SBCSerializer () 

---