Table Of Contents

Previous topic

SDsoClass Structure

Next topic

SSerializedFile Structure

Serialization

Reading/Writing and loading/saving of serialized objects and files.

Summary

SSerializedObjectRegister Register the given SSerializedObjectClass with the Speect Engine.
SSerializedObjectFree Free the given SSerializedObjectClass from the Speect Engine.
SSerializedObjectGet Get the given SSerializedObjectClass from the Speect Engine.
SSerializedFileRegister Register the given SSerializedFileClass with the Speect Engine.
SSerializedFileFree Free the given SSerializedFileClass from the Speect Engine.
SSerializedObjectRead Read an object’s data from a serialized data source.
SSerializedObjectWrite Write an object’s data to a serialized data source.

Definitions

speect object SSerializedFile

Inheritance diagram of SObject.SSerializedFile

The abstract serialized file structure.

Provides an abstract interface to a serialized file reader/writer. All classes that want to read/write an SObject type from/to file must inherit from this object’s class.

SSerializedFile Structure

speect class SSerializedFileClass

Inheritance diagram of SObjectClass.SSerializedFileClass

The abstract serialized file class structure.

SSerializedFileClass Structure

speect object SSerializedObject

Inheritance diagram of SObject.SSerializedObject

The abstract serialized object structure.

Definition of the serialized object data source.

Provides an abstract interface to a serialized object reader/writer. All classes that want to read/write an SObject type from/to file must inherit from this object’s class.

SSerializedObject Structure

speect class SSerializedObjectClass

Inheritance diagram of SObjectClass.SSerializedObjectClass

The abstract serialized object class structure.

SSerializedObjectClass Structure

Functions

void SSerializedObjectRegister(const SSerializedObjectClass *serializedObjectClass, s_erc *error)

Register the given SSerializedObjectClass with the Speect Engine.

Parameters:
  • serializedObjectClass

    The given serialized object class to register.

  • error

    Error code.

void SSerializedObjectFree(const SSerializedObjectClass *serializedObjectClass, s_erc *error)

Free the given SSerializedObjectClass from the Speect Engine.

Parameters:
  • serializedObjectClass

    The given serialized object class to free.

  • error

    Error code.

const SSerializedObject *SSerializedObjectGet(const SObject *object, const char *format, s_erc *error)

Get the given SSerializedObjectClass from the Speect Engine.

Parameters:
  • object

    The object for which a serialized formatter is requested.

  • format

    The format of the requested serialized formatter.

  • error

    Error code.

Return:

A serialized object formatter.

void SSerializedFileRegister(const SSerializedFileClass *serializedFileClass, s_erc *error)

Register the given SSerializedFileClass with the Speect Engine.

Parameters:
  • serializedFileClass

    The given serialized file class to register.

  • error

    Error code.

void SSerializedFileFree(const SSerializedFileClass *serializedFileClass, s_erc *error)

Free the given SSerializedFileClass from the Speect Engine.

Parameters:
  • serializedFileClass

    The given serialized file class to free.

  • error

    Error code.

void SSerializedObjectRead(const SSerializedObject *self, SDataReader *reader, SObject *object, s_erc *error)

Read an object’s data from a serialized data source.

This is just a wrapper function for the class method.

Parameters:
  • self

    The serialized object formater.

  • reader

    The serialized data reader.

  • object

    The object’s data to read.

  • error

    Error code.

void SSerializedObjectWrite(const SSerializedObject *self, SDataWriter *writer, const SObject *object, s_erc *error)

Write an object’s data to a serialized data source.

This is just a wrapper function for the class method.

Parameters:
  • self

    The serialized object formater.

  • writer

    The serialized data writer.

  • object

    The object’s data to write.

  • error

    Error code.