Loading...
Searching...
No Matches
SBCSerializer Class Reference

This class is the base class for serializers.

Constructors and destructors

 SBCSerializer ()
 
virtual ~SBCSerializer ()
 

Writing elements

virtual void writeStartElement (const std::string &elementName)
 Writes the start element with elementName name.
 
virtual void writeEndElement ()
 Writes the end element.
 
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 writeBoolElement (const std::string &elementName, bool element)
 Writes an element of boolean type with elementName name and value element.
 
virtual void writeCharElement (const std::string &elementName, char element)
 Writes an element of char 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 writeShortElement (const std::string &elementName, short element)
 Writes an element of short 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 void writeIntElement (const std::string &elementName, int element)
 Writes an element of integer 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 writeLongElement (const std::string &elementName, long element)
 Writes an element of long 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 writeLongLongElement (const std::string &elementName, long long element)
 Writes an element of long 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 writeFloatElement (const std::string &elementName, float element)
 Writes an element of float 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 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.
 

Reading elements

virtual void readStartElement ()
 Reads the start element.
 
virtual void readEndElement ()
 Reads the end 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 bool readBoolElement ()
 Reads an element of boolean type.
 
virtual char readCharElement ()
 Reads an element of char type.
 
virtual unsigned char readUnsignedCharElement ()
 Reads an element of unsigned char type.
 
virtual short readShortElement ()
 Reads an element of short integer type.
 
virtual unsigned short readUnsignedShortElement ()
 Reads an element of unsigned short integer type.
 
virtual int readIntElement ()
 Reads an element of integer type.
 
virtual unsigned int readUnsignedIntElement ()
 Reads an element of unsigned integer type.
 
virtual long readLongElement ()
 Reads an element of long integer type.
 
virtual unsigned long readUnsignedLongElement ()
 Reads an element of unsigned long integer type.
 
virtual long long readLongLongElement ()
 Reads an element of long long integer type.
 
virtual unsigned long long readUnsignedLongLongElement ()
 Reads an element of unsigned long long integer type.
 
virtual float readFloatElement ()
 Reads an element of float type.
 
virtual double readDoubleElement ()
 Reads an element of double type.
 
virtual char * readCharArrayElement (unsigned int &arraySize)
 Reads an element of char array type of size arraySize.
 

Member Function Documentation

◆ readBoolElement()

bool SBCSerializer::readBoolElement ( )
virtual

◆ readCharArrayElement()

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

◆ readCharElement()

char SBCSerializer::readCharElement ( )
virtual

◆ readDoubleElement()

double SBCSerializer::readDoubleElement ( )
virtual

◆ readEndElement()

void SBCSerializer::readEndElement ( )
virtual

◆ readFloatElement()

float SBCSerializer::readFloatElement ( )
virtual

◆ readIntElement()

int SBCSerializer::readIntElement ( )
virtual

◆ readLongElement()

long SBCSerializer::readLongElement ( )
virtual

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.

Reimplemented in SBCSerializerBinary, SBCSerializerMemory, and SBCSerializerXML.

◆ readLongLongElement()

long long SBCSerializer::readLongLongElement ( )
virtual

◆ readShortElement()

short SBCSerializer::readShortElement ( )
virtual

◆ readStartElement()

void SBCSerializer::readStartElement ( )
virtual

◆ readStringElement()

std::string SBCSerializer::readStringElement ( )
virtual

◆ readStringElementFromBase64()

std::string SBCSerializer::readStringElementFromBase64 ( )
virtual

◆ readUnsignedCharElement()

unsigned char SBCSerializer::readUnsignedCharElement ( )
virtual

◆ readUnsignedIntElement()

unsigned int SBCSerializer::readUnsignedIntElement ( )
virtual

◆ readUnsignedLongElement()

unsigned long SBCSerializer::readUnsignedLongElement ( )
virtual

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.

Reimplemented in SBCSerializerBinary, SBCSerializerMemory, and SBCSerializerXML.

◆ readUnsignedLongLongElement()

unsigned long long SBCSerializer::readUnsignedLongLongElement ( )
virtual

◆ readUnsignedShortElement()

unsigned short SBCSerializer::readUnsignedShortElement ( )
virtual

◆ writeBoolElement()

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

◆ writeCharArrayElement()

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

◆ writeCharElement()

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

◆ writeDoubleElement()

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

◆ writeEndElement()

void SBCSerializer::writeEndElement ( )
virtual

◆ writeFloatElement()

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

◆ writeIntElement()

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

◆ writeLongElement()

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

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.

Reimplemented in SBCSerializerBinary, SBCSerializerMemory, and SBCSerializerXML.

◆ writeLongLongElement()

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

◆ writeShortElement()

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

◆ writeStartElement()

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

◆ writeStringElement()

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

◆ writeStringElementInBase64()

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

◆ writeUnsignedCharElement()

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

◆ writeUnsignedIntElement()

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

◆ writeUnsignedLongElement()

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

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.

Reimplemented in SBCSerializerBinary, SBCSerializerMemory, and SBCSerializerXML.

◆ writeUnsignedLongLongElement()

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

◆ writeUnsignedShortElement()

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