Gizmo3D

gzSerialize.h File Reference

Serialized Management. More...

#include "gzBasicTypes.h"
#include "gzMemory.h"
#include "gzBase.h"
#include "gzTemplates.h"
#include "gzMatrix.h"
#include "gzMutex.h"
#include "gzGuid.h"
#include "gzXYZ.h"
#include "gzIO.h"

Go to the source code of this file.

Classes

class  gzAdapterSharedData
class  gzSerializeURLManagerInterface
class  gzSerializeAdapter
class  gzSerializeAdapterStdIO
class  gzSerializeAdapterMemory
class  gzSerializeAdapterFile
class  gzSerializeAdapterFile::gzFileQueue
class  gzSerializeData
class  gzSerializePacketInterface
class  gzSerializeBinary< T >
class  gzVarULongLong
class  gzSerializeArray< T >
class  gzSerializeDynamicArray< T >
class  gzSerializeString
class  gzSerializeStringWide
class  gzSerializeVec2
class  gzSerializeVec3
class  gzSerializeVec4
class  gzSerializeGUID
class  gzSerializeMatrix4
class  gzSerializeBinaryArray< T >
class  gzSerializeAdapterEncoder
class  gzSerializeAdapterBCDEncoder
class  gzSerializeAdapterBase64Encoder
class  gzSerializeAdapterRandomAccess
class  gzSerializeAdapterCompress
class  gzSerializeAdapterQueue
class  gzSerializeAdapterString
class  gzLogger
class  gzMessageDatabase
class  gzMessageDatabase::gzMessageDatabaseEntry
class  gzMessageDatabase::gzMessageDatabaseLevel
class  gzMessageDatabase::gzMessageDatabaseSender
class  gzWriteAdapterStringUtils
class  gzCacheData
class  gzSerializeAdapterCache

Defines

#define writeAdapterString   gzWriteAdapterStringUtils::writeAdapterString

Typedefs

typedef gzULongLong gzSerializeAdapterFlags
typedef gzSerializePacketInterface * gzSerializePacketInterfacePtr

Enumerations

enum  gzSerializeAction { GZ_SERIALIZE_OUTPUT = 1, GZ_SERIALIZE_INPUT = 2, GZ_SERIALIZE_DUPLEX = GZ_SERIALIZE_OUTPUT|GZ_SERIALIZE_INPUT }

Functions

 GZ_DECLARE_REFPTR (gzSerializeAdapter)
 GZ_DECLARE_REFPTR (gzSerializeAdapterMemory)
 GZ_DECLARE_REFPTR (gzSerializeAdapterEncoder)
 GZ_DECLARE_REFPTR (gzSerializeAdapterBCDEncoder)
 GZ_DECLARE_REFPTR (gzSerializeAdapterBase64Encoder)
 GZ_DECLARE_REFPTR (gzSerializeAdapterRandomAccess)
 GZ_DECLARE_REFPTR (gzSerializeAdapterCompress)
 GZ_DECLARE_REFPTR (gzSerializeAdapterQueue)
 GZ_DECLARE_REFPTR (gzSerializeAdapterString)
template<class T>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const T &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzString &data, const gzBool useBigEndian)
template<class T>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzXY< T > &data, const gzBool useBigEndian=TRUE)
template<class T>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzXYZ< T > &data, const gzBool useBigEndian=TRUE)
template<class T>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzArray< gzString > &data, const gzBool useBigEndian)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzArray< gzUByte > &data, const gzBool useBigEndian)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzArray< gzULong > &data, const gzBool useBigEndian)
template<class T>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzDynamicArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzDynamicArray< gzUByte > &data, const gzBool useBigEndian)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzVec3 &data, const gzBool useBigEndian)
template<>
gzVoid writeAdapter (gzSerializeAdapter *adapter, const gzVec4 &data, const gzBool useBigEndian)
template<class T>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const T &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzString &data, const gzBool useBigEndian)
template<class T>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzArray< gzULong > &data, const gzBool useBigEndian)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzArray< gzString > &data, const gzBool useBigEndian)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzArray< gzUByte > &data, const gzBool useBigEndian)
template<class T>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzDynamicArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzDynamicArray< gzUByte > &data, const gzBool useBigEndian)
template<class T>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzXY< T > &data, const gzBool useBigEndian=TRUE)
template<class T>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzXYZ< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzVec3 &data, const gzBool useBigEndian)
template<>
gzVoid pushBackAdapter (gzSerializeAdapter *adapter, const gzVec4 &data, const gzBool useBigEndian)
template<class T>
gzBool readAdapter (gzSerializeAdapter *adapter, T &data, const gzBool useBigEndian=TRUE)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzString &data, const gzBool useBigEndian)
template<class T>
gzBool readAdapter (gzSerializeAdapter *adapter, gzXY< T > &data, const gzBool useBigEndian=TRUE)
template<class T>
gzBool readAdapter (gzSerializeAdapter *adapter, gzXYZ< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzVec3 &data, const gzBool useBigEndian)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzVec4 &data, const gzBool useBigEndian)
template<class T>
gzBool readAdapter (gzSerializeAdapter *adapter, gzArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzArray< gzUByte > &data, const gzBool useBigEndian)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzArray< gzULong > &data, const gzBool useBigEndian)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzArray< gzString > &data, const gzBool useBigEndian)
template<class T>
gzBool readAdapter (gzSerializeAdapter *adapter, gzDynamicArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzBool readAdapter (gzSerializeAdapter *adapter, gzDynamicArray< gzUByte > &data, const gzBool useBigEndian)
template<class T>
gzULong getDataSize (gzSerializeAdapter *adapter, const T &data, const gzBool useBigEndian=TRUE)
template<>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzString &data, const gzBool useBigEndian)
template<class T>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzArray< gzString > &data, const gzBool useBigEndian)
template<>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzArray< gzUByte > &data, const gzBool useBigEndian)
template<>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzArray< gzULong > &data, const gzBool useBigEndian)
template<class T>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzDynamicArray< T > &data, const gzBool useBigEndian=TRUE)
template<>
gzULong getDataSize (gzSerializeAdapter *adapter, const gzDynamicArray< gzUByte > &data, const gzBool useBigEndian)
template<class T1, class T2>
gzVoid _writeAdapter (gzSerializeAdapter *adapter, const T1 &data)
template<class T1, class T2>
gzVoid _pushBackAdapter (gzSerializeAdapter *adapter, const T1 &data)
template<class T1, class T2>
gzBool _readAdapter (gzSerializeAdapter *adapter, T1 &data)
template<class T1, class T2>
gzULong _getDataSize (gzSerializeAdapter *adapter, const T1 &data)
gzBool readLine (gzString &result, gzSerializeAdapter *adapter=gzSerializeAdapter::getURLAdapter("con:"))

Variables

const gzString GZ_LOG_NAME = "gizmosdk.log"
const gzString GZ_URLBASE_FILE = "file:"
const gzString GZ_URLBASE_HTTP = "http:"
const gzString GZ_URLBASE_FTP = "ftp:"
const gzString GZ_URLBASE_MEMORY = "mem:"
const gzString GZ_URLBASE_REGISTRY = "reg:"
const gzString GZ_URLBASE_ZIP = "zip:"
const gzString GZ_URLBASE_PIPE = "pipe:"
const gzString GZ_URLBASE_PURL = "purl:"
const gzString GZ_URLBASE_CONSOLE = "con:"
const gzString GZ_URLBASE_CACHE = "cache:"
const gzString GZ_URLBASE_ADAPTER = "adapt:"
const gzString GZ_URLBASE_RANDOM_ACCESS = "rand:"
const gzSerializeAdapterFlags GZ_SERIALIZE_ADAPTER_FLAGS_DEFAULT = 0
const gzSerializeAdapterFlags GZ_SERIALIZE_ADAPTER_NO_ERROR_MSG = (1<<0)
const gzSerializeAdapterFlags GZ_SERIALIZE_ADAPTER_WIDECHAR = (1<<1)
const gzSerializeAdapterFlags GZ_SERIALIZE_ADAPTER_BIG_ENDIAN = (1<<2)
const gzULong GZ_SERIALIZE_ADAPTER_FLAG_MAX_SIZE = 3
 Definition of how many flags there are in gzImageFlags.
const gzString GZ_SERIALIZE_PACKET_INTERFACE = "gzSerializePacketInterface"

Detailed Description

Serialized Management.

Gizmo3D uses serialize patterns for file and data storage/retreival

Definition in file gzSerialize.h.

Define Documentation

#define writeAdapterString   gzWriteAdapterStringUtils::writeAdapterString
 

Definition at line 2549 of file gzSerialize.h.

Typedef Documentation

typedef gzULongLong gzSerializeAdapterFlags
 

These flags defines the behaviour of how the loader processes at load time

Examples:
dbviewer.cpp.

Definition at line 91 of file gzSerialize.h.

typedef gzSerializePacketInterface* gzSerializePacketInterfacePtr
 

Definition at line 452 of file gzSerialize.h.

Enumeration Type Documentation

enum gzSerializeAction
 

Enumerator:
GZ_SERIALIZE_OUTPUT 
GZ_SERIALIZE_INPUT 
GZ_SERIALIZE_DUPLEX 

Definition at line 44 of file gzSerialize.h.

Function Documentation

template<class T1, class T2>
gzULong _getDataSize (  gzSerializeAdapter *  adapter,
const T1 &  data
)  [inline]
 

Definition at line 2527 of file gzSerialize.h.

template<class T1, class T2>
gzVoid _pushBackAdapter (  gzSerializeAdapter *  adapter,
const T1 &  data
)  [inline]
 

Definition at line 2504 of file gzSerialize.h.

template<class T1, class T2>
gzBool _readAdapter (  gzSerializeAdapter *  adapter,
T1 &  data
)  [inline]
 

Definition at line 2513 of file gzSerialize.h.

References FALSE, gzSerializeAdapter::length(), and TRUE.

template<class T1, class T2>
gzVoid _writeAdapter (  gzSerializeAdapter *  adapter,
const T1 &  data
)  [inline]
 

Definition at line 2495 of file gzSerialize.h.

template<>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzDynamicArray< gzUByte > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2486 of file gzSerialize.h.

References gzVarULongLong::getDataSize(), and gzDynamicArray< T >::getSize().

template<class T>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzDynamicArray< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2478 of file gzSerialize.h.

References gzVarULongLong::getDataSize(), gzSerializeDynamicArray< T >::getDataSize(), and gzDynamicArray< T >::getSize().

template<>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzArray< gzULong > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2471 of file gzSerialize.h.

References gzVarULongLong::getDataSize(), and gzArray< T >::getSize().

template<>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzArray< gzUByte > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2465 of file gzSerialize.h.

References gzVarULongLong::getDataSize(), and gzArray< T >::getSize().

template<>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzArray< gzString > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2450 of file gzSerialize.h.

References gzArray< T >::get(), gzArray< T >::getSize(), and gzString::length().

template<class T>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzArray< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2442 of file gzSerialize.h.

References gzArray< T >::getSize().

template<>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const gzString &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2437 of file gzSerialize.h.

References gzString::length().

template<class T>
gzULong getDataSize (  gzSerializeAdapter *  adapter,
const T &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2432 of file gzSerialize.h.

GZ_DECLARE_REFPTR (  gzSerializeAdapterString   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterQueue   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterCompress   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterRandomAccess   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterBase64Encoder   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterBCDEncoder   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterEncoder   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapterMemory   ) 
 

GZ_DECLARE_REFPTR (  gzSerializeAdapter   ) 
 

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzVec4 &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2196 of file gzSerialize.h.

References gzSerializeVec4::pushBack().

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzVec3 &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2187 of file gzSerialize.h.

References gzSerializeVec3::pushBack().

template<class T>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzXYZ< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2169 of file gzSerialize.h.

References gzSerializeBinary< T >::pushBack(), gzXYZ< T >::x, gzXYZ< T >::y, and gzXYZ< T >::z.

template<class T>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzXY< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2155 of file gzSerialize.h.

References gzSerializeBinary< T >::pushBack(), gzXY< T >::x, and gzXY< T >::y.

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzDynamicArray< gzUByte > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2140 of file gzSerialize.h.

References gzDynamicArray< T >::getSize(), gzLargeValCast, and gzSerializeAdapter::pushBack().

template<class T>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzDynamicArray< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2126 of file gzSerialize.h.

References gzDynamicArray< T >::getSize().

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzArray< gzUByte > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2111 of file gzSerialize.h.

References gzArray< T >::getSize(), gzLargeValCast, and gzSerializeAdapter::pushBack().

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzArray< gzString > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2091 of file gzSerialize.h.

References gzArray< T >::get(), gzArray< T >::getSize(), and gzLargeValCast.

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzArray< gzULong > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2082 of file gzSerialize.h.

References gzSerializeBinaryArray< T >::pushBack().

template<class T>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzArray< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2069 of file gzSerialize.h.

References gzArray< T >::getSize().

template<>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const gzString &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2060 of file gzSerialize.h.

References gzSerializeString::pushBack().

template<class T>
gzVoid pushBackAdapter (  gzSerializeAdapter *  adapter,
const T &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2051 of file gzSerialize.h.

References gzSerializeBinary< T >::pushBack().

template<>
gzBool readAdapter (  gzSerializeAdapter *  adapter,
gzDynamicArray< gzUByte > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2411 of file gzSerialize.h.

References FALSE, gzDynamicArray< T >::getAddress(), gzLargeValCast, gzSerializeAdapter::length(), gzVarULongLong::read(), gzDynamicArray< T >::setSize(), and TRUE.

template<class T>
gzBool readAdapter (  gzSerializeAdapter *  adapter,
gzDynamicArray< T > &  data,
const gzBool  useBigEndian = TRUE
)  [inline]
 

Definition at line 2390 of file gzSerialize.h.

References FALSE, gzSerializeAdapter::length(), gzSerializeDynamicArray< T >::read(), gzVarULongLong::read(), gzSerializeDynamicArray< T >::setSize(), and TRUE.

template<>
gzBool readAdapter (  gzSerializeAdapter *  adapter,
gzArray< gzString > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2364 of file gzSerialize.h.

References FALSE, gzArray< T >::getSize(), gzLargeValCast, gzSerializeAdapter::length(), gzSerializeString::read(), and gzArray< T >::setSize().

template<>
gzBool readAdapter (  gzSerializeAdapter *  adapter,
gzArray< gzULong > &  data,
const gzBool  useBigEndian
)  [inline]
 

Definition at line 2353 of file gzSerialize.h.

References gzSerializeBinaryArray< T >::read(), and TRUE.

template<>
gzBool readAdapter (  gzSerializeAdapter *  adapter