TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class Serializer in Tinman.Core.IO.Serialization

Default implementation of the ISerializable interface that uses an IDataStream for reading and writing binary data.

sealed class Serializer extends SerializerStream

Public / Constants

Int32

An instance of ITypeSerializer for signed 32-bit integers.

public static readonly field Int32
type ITypeSerializer<int32>

Public / Constructors

For

Creates a new instance of ISerializer.

public static method For (IDataStream stream, bool loadLazy = true)
type Serializer
params stream [not-null] The data stream to use.
  loadLazy Load lazy types if necessary? Defaults to true.
returns [not-null] The created ISerializer object.

Public / Methods

Clone

Clones the given serializable object.

public static method Clone (ISerializable obj)
type ISerializable
params obj The object to clone.
returns The cloned object.

Remarks:

The clone is created by first serializing the given object and then deserializing the clone from the binary data stream.

Deserialize

Deserializes an object from the given data stream.

[OwnerReturn]
public static method Deserialize ([Owner] IDataStream stream, bool loadLazy = true)
type ISerializable
params stream [not-null] The data stream.
  loadLazy Load lazy types if necessary? Defaults to true.
returns The deserialized object or null.

Deserializes an object from the given byte buffer.

[OwnerReturn]
public static method Deserialize ([Owner] ByteBuffer buffer, bool loadLazy = true)
type ISerializable
params buffer The byte buffer.
  loadLazy Load lazy types if necessary? Defaults to true.
returns The deserialized object or null if the serialized object was null or buffer is null.

Remarks:

LittleEndian will be used for reading multi-byte values.

Deserializes an object from the given file.

[OwnerReturn]
public static method Deserialize (Path file, bool loadLazy = true)
type ISerializable
params file [not-null] The file path.
  loadLazy Load lazy types if necessary? Defaults to true.
returns The deserialized object or null.

Remarks:

LittleEndian will be used for reading multi-byte values.

Flush

Flushes all cached data.

public override method Flush ()
inherited SerializerStream.Flush

Remarks:

Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.

In case this object represents a read-only resource, calling the Flush method has no effect.

Read

Reads a number of bytes from the stream.

public override method Read (ByteBuffer bytes)
type int32
params bytes [not-null] The buffer where the read bytes will be stored.
returns [>=0] The number of bytes the have been read.
inherited SerializerStream.Read

Remarks:

The number of bytes that are read from the stream may be less than the number of Remaining bytes in the given ByteBuffer, for any arbitrary reason.

Exceptions:

ReadAll

Reads a number of bytes from the stream.

public override method ReadAll (ByteBuffer bytes)
params bytes [not-null] The buffer where the read bytes will be stored.
inherited SerializerStream.ReadAll

Remarks:

The number of bytes that are read from the stream will be equal to the number of Remaining bytes in the given ByteBuffer.

Exceptions:

ReadBool

Returns a data token of the object being deserialized.

public method ReadBool ()
type bool
returns The data token value.
inherited SerializerBase.ReadBool

ReadBoolArray

Returns a data token of the object being deserialized.

public method ReadBoolArray ()
type bool[]
returns The data token value.
inherited SerializerBase.ReadBoolArray

ReadByteBuffer

Returns a data token of the object being deserialized.

[OwnerReturn]
public method ReadByteBuffer ()
type ByteBuffer
returns The data token value.
inherited SerializerBase.ReadByteBuffer

ReadFloat32

Reads a 32-bit floating point value from the data stream.

public override method ReadFloat32 ()
type float32
returns The read value.
inherited SerializerStream.ReadFloat32

Exceptions:

ReadFloat32Array

Returns a data token of the object being deserialized.

public method ReadFloat32Array ()
type float32[]
returns The data token value.
inherited SerializerBase.ReadFloat32Array

ReadFloat32s

Reads 32-bit floating point values from the data stream.

public override method ReadFloat32s (float32[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadFloat32s

Exceptions:

ReadFloat64

Reads a 64-bit floating point value from the data stream.

public override method ReadFloat64 ()
type float64
returns The read value.
inherited SerializerStream.ReadFloat64

Exceptions:

ReadFloat64Array

Returns a data token of the object being deserialized.

public method ReadFloat64Array ()
type float64[]
returns The data token value.
inherited SerializerBase.ReadFloat64Array

ReadFloat64s

Reads 64-bit floating point values from the data stream.

public override method ReadFloat64s (float64[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadFloat64s

Exceptions:

ReadInt16

Reads a signed 16-bit integer value from the data stream using.

public override method ReadInt16 ()
type int16
returns The read value.
inherited SerializerStream.ReadInt16

Exceptions:

ReadInt16Array

Returns a data token of the object being deserialized.

public method ReadInt16Array ()
type int16[]
returns The data token value.
inherited SerializerBase.ReadInt16Array

ReadInt16s

Reads signed 16-bit integer value values from the data stream.

public override method ReadInt16s (int16[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadInt16s

Exceptions:

ReadInt32

Reads a signed 32-bit integer value from the data stream.

public override method ReadInt32 ()
type int32
returns The read value.
inherited SerializerStream.ReadInt32

Exceptions:

ReadInt32Array

Returns a data token of the object being deserialized.

public method ReadInt32Array ()
type int32[]
returns The data token value.
inherited SerializerBase.ReadInt32Array

ReadInt32s

Reads signed 32-bit integer value values from the data stream.

public override method ReadInt32s (int32[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadInt32s

Exceptions:

ReadInt64

Reads a signed 64-bit integer value from the data stream.

public override method ReadInt64 ()
type int64
returns The read value.
inherited SerializerStream.ReadInt64

Exceptions:

ReadInt64Array

Returns a data token of the object being deserialized.

public method ReadInt64Array ()
type int64[]
returns The data token value.
inherited SerializerBase.ReadInt64Array

ReadInt64s

Reads signed 64-bit integer value values from the data stream.

public override method ReadInt64s (int64[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadInt64s

Exceptions:

ReadInt8

Reads an 8-bit value from the stream.

public override method ReadInt8 ()
type int8
returns The read value.
inherited SerializerStream.ReadInt8

Exceptions:

ReadInt8Array

Returns a data token of the object being deserialized.

public method ReadInt8Array ()
type int8[]
returns The data token value.
inherited SerializerBase.ReadInt8Array

ReadInt8s

Reads signed 8-bit integer value values from the data stream.

public override method ReadInt8s (int8[] array, int32 offset, int32 count)
params array [not-null] The output array.
  offset [>=0] Index of first array element to write.
  count [>=0] Number of values to read.
returns The read value.
inherited SerializerStream.ReadInt8s

Exceptions:

ReadObject

Returns a data token of the object being deserialized.

[OwnerReturn]
public override method ReadObject ()
type ISerializable
returns The data token value.
implements SerializerBase.ReadObject

ReadString

Returns a data token of the object being deserialized.

public virtual method ReadString ()
type string
returns The data token value.
inherited SerializerBase.ReadString

ReadUInt16

Reads an unsigned 16-bit integer value from the data stream.

public method ReadUInt16 ()
type int32
returns The read value.
inherited SerializerBase.ReadUInt16

Exceptions:

ReadUInt32

Reads an unsigned 32-bit integer value from the data stream.

public method ReadUInt32 ()
type int64
returns The read value.
inherited SerializerBase.ReadUInt32

Exceptions:

ReadUInt8

Reads an unsigned 8-bit integer from the data stream.

public method ReadUInt8 ()
type int32
returns The read value.
inherited SerializerBase.ReadUInt8

Exceptions:

Serialize

Serializes the given object.

[OwnerReturn]
public static method Serialize (ISerializable obj)
type ByteBuffer
params obj The object to serialize or null.
returns [not-null] The byte buffer that holds the serialized object data.

Remarks:

LittleEndian will be used for writing multi-byte values.

Serializes the given object.

[OwnerReturn]
public static method Serialize (ISerializable obj, IDataStream stream)
params obj The object to serialize or null.
  stream [not-null] The stream to serialize to.

Serializes the given object to the given file.

public static method Serialize (ISerializable obj, Path file)
params obj The object to serialize or null.
  file [not-null] The file path.

Remarks:

LittleEndian will be used for writing multi-byte values.

TryReadUInt8

Reads an unsigned 8-bit value from the stream.

public override method TryReadUInt8 ()
type int32
returns [-1..255] The unsigned 8-bit value or -1 if the end of the stream has been reached.
inherited SerializerStream.TryReadUInt8

Write

Writes a number of bytes to the stream.

public override method Write (ByteBuffer bytes)
params bytes [not-null] The bytes to write.
inherited SerializerStream.Write

Exceptions:

WriteBool

Writes the value of a data token of the object being serialized.

public method WriteBool (bool value)
params value The data token value.
inherited SerializerBase.WriteBool

WriteBoolArray

Writes the value of a data token of the object being serialized.

public method WriteBoolArray (bool[] value)
params value The data token value.
inherited SerializerBase.WriteBoolArray

Writes the value of a data token of the object being serialized.

public method WriteBoolArray ([] bool[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteBoolArray

WriteByteBuffer

Writes the value of a data token of the object being serialized.

public method WriteByteBuffer (ByteBuffer buffer)
params buffer The data token value.
inherited SerializerBase.WriteByteBuffer

WriteFloat32

Writes a 32-bit floating point value to the data stream.

public override method WriteFloat32 (float32 value)
params value The value to write.
inherited SerializerStream.WriteFloat32

Exceptions:

WriteFloat32Array

Writes the value of a data token of the object being serialized.

public method WriteFloat32Array (float32[] value)
params value The data token value.
inherited SerializerBase.WriteFloat32Array

Writes the value of a data token of the object being serialized.

public method WriteFloat32Array ([] float32[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteFloat32Array

WriteFloat32s

Writes 32-bit floating point values to the data stream.

public override method WriteFloat32s (float32[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteFloat32s

Exceptions:

WriteFloat64

Writes a 64-bit floating point value to the data stream.

public override method WriteFloat64 (float64 value)
params value The value to write.
inherited SerializerStream.WriteFloat64

Exceptions:

WriteFloat64Array

Writes the value of a data token of the object being serialized.

public method WriteFloat64Array (float64[] value)
params value The data token value.
inherited SerializerBase.WriteFloat64Array

Writes the value of a data token of the object being serialized.

public method WriteFloat64Array ([] float64[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteFloat64Array

WriteFloat64s

Writes 64-bit floating point values to the data stream.

public override method WriteFloat64s (float64[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteFloat64s

Exceptions:

WriteInt16

Writes a signed 16-bit integer value to the data stream.

public override method WriteInt16 (int16 value)
params value The value to write.
inherited SerializerStream.WriteInt16

Exceptions:

WriteInt16Array

Writes the value of a data token of the object being serialized.

public method WriteInt16Array (int16[] value)
params value The data token value.
inherited SerializerBase.WriteInt16Array

Writes the value of a data token of the object being serialized.

public method WriteInt16Array ([] int16[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteInt16Array

WriteInt16s

Writes signed 16-bit integer values to the data stream.

public override method WriteInt16s (int16[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteInt16s

Exceptions:

WriteInt32

Writes a signed 32-bit integer value to the data stream.

public override method WriteInt32 (int32 value)
params value The value to write.
inherited SerializerStream.WriteInt32

Exceptions:

WriteInt32Array

Writes the value of a data token of the object being serialized.

public method WriteInt32Array (int32[] value)
params value The data token value.
inherited SerializerBase.WriteInt32Array

Writes the value of a data token of the object being serialized.

public method WriteInt32Array ([] int32[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteInt32Array

WriteInt32s

Writes signed 32-bit integer values to the data stream.

public override method WriteInt32s (int32[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteInt32s

Exceptions:

WriteInt64

Writes a signed 64-bit integer value to the data stream.

public override method WriteInt64 (int64 value)
params value The value to write.
inherited SerializerStream.WriteInt64

Exceptions:

WriteInt64Array

Writes the value of a data token of the object being serialized.

public method WriteInt64Array (int64[] value)
params value The data token value.
inherited SerializerBase.WriteInt64Array

Writes the value of a data token of the object being serialized.

public method WriteInt64Array ([] int64[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteInt64Array

WriteInt64s

Writes signed 64-bit integer values to the data stream.

public override method WriteInt64s (int64[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteInt64s

Exceptions:

WriteInt8

Writes an 8-bit integer value to the stream.

public override method WriteInt8 (int8 value)
params value The value to write.
inherited SerializerStream.WriteInt8

Exceptions:

WriteInt8Array

Writes the value of a data token of the object being serialized.

public method WriteInt8Array (int8[] value)
params value The data token value.
inherited SerializerBase.WriteInt8Array

Writes the value of a data token of the object being serialized.

public method WriteInt8Array ([] int8[] value, int32 first, int32 count)
params value The data token value.
  first [>=0] Index of first array element to write.
  count [>=0] Number array elements to write.
inherited SerializerBase.WriteInt8Array

WriteInt8s

Writes signed 8-bit integer values to the data stream.

public override method WriteInt8s (int8[] array, int32 offset, int32 count)
params array [not-null] The input array.
  offset [>=0] Index of first array element to read.
  count [>=0] Number of values to write.
returns The read value.
inherited SerializerStream.WriteInt8s

Exceptions:

WriteObject

Writes the value of a data token of the object being serialized.

public override method WriteObject (ISerializable value)
params value The data token value.
implements SerializerBase.WriteObject

WriteString

Writes the value of a data token of the object being serialized.

public virtual method WriteString (string value)
params value The data token value.
inherited SerializerBase.WriteString
Tinman 3D SDK v1.0 | info@tinman3d.com | Copyright © 2012 - 2017 Matthias Englert, Fulda (Germany)