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

class SerializerBase in Tinman.Core.IO.Serialization

Abstract base class for ISerializer implementations.

abstract class SerializerBase implements ISerializer
  base of SerializerStream

Public / Methods

Flush

Flushes all cached data.

public abstract method Flush ()
implements IFlushable.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 abstract 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.
implements IBinaryReader.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 abstract method ReadAll (ByteBuffer bytes)
params bytes [not-null] The buffer where the read bytes will be stored.
implements IBinaryReader.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.
implements ISerializer.ReadBool

ReadBoolArray

Returns a data token of the object being deserialized.

public method ReadBoolArray ()
type bool[]
returns The data token value.
implements ISerializer.ReadBoolArray

ReadByteBuffer

Returns a data token of the object being deserialized.

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

ReadFloat32

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

public abstract method ReadFloat32 ()
type float32
returns The read value.
implements IBinaryReader.ReadFloat32

Exceptions:

ReadFloat32Array

Returns a data token of the object being deserialized.

public method ReadFloat32Array ()
type float32[]
returns The data token value.
implements ISerializer.ReadFloat32Array

ReadFloat32s

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

public abstract 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.
implements IBinaryReader.ReadFloat32s

Exceptions:

ReadFloat64

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

public abstract method ReadFloat64 ()
type float64
returns The read value.
implements IBinaryReader.ReadFloat64

Exceptions:

ReadFloat64Array

Returns a data token of the object being deserialized.

public method ReadFloat64Array ()
type float64[]
returns The data token value.
implements ISerializer.ReadFloat64Array

ReadFloat64s

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

public abstract 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.
implements IBinaryReader.ReadFloat64s

Exceptions:

ReadInt16

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

public abstract method ReadInt16 ()
type int16
returns The read value.
implements IBinaryReader.ReadInt16

Exceptions:

ReadInt16Array

Returns a data token of the object being deserialized.

public method ReadInt16Array ()
type int16[]
returns The data token value.
implements ISerializer.ReadInt16Array

ReadInt16s

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

public abstract 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.
implements IBinaryReader.ReadInt16s

Exceptions:

ReadInt32

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

public abstract method ReadInt32 ()
type int32
returns The read value.
implements IBinaryReader.ReadInt32

Exceptions:

ReadInt32Array

Returns a data token of the object being deserialized.

public method ReadInt32Array ()
type int32[]
returns The data token value.
implements ISerializer.ReadInt32Array

ReadInt32s

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

public abstract 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.
implements IBinaryReader.ReadInt32s

Exceptions:

ReadInt64

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

public abstract method ReadInt64 ()
type int64
returns The read value.
implements IBinaryReader.ReadInt64

Exceptions:

ReadInt64Array

Returns a data token of the object being deserialized.

public method ReadInt64Array ()
type int64[]
returns The data token value.
implements ISerializer.ReadInt64Array

ReadInt64s

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

public abstract 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.
implements IBinaryReader.ReadInt64s

Exceptions:

ReadInt8

Reads an 8-bit value from the stream.

public abstract method ReadInt8 ()
type int8
returns The read value.
implements IBinaryReader.ReadInt8

Exceptions:

ReadInt8Array

Returns a data token of the object being deserialized.

public method ReadInt8Array ()
type int8[]
returns The data token value.
implements ISerializer.ReadInt8Array

ReadInt8s

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

public abstract 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.
implements IBinaryReader.ReadInt8s

Exceptions:

ReadObject

Returns a data token of the object being deserialized.

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

ReadString

Returns a data token of the object being deserialized.

public virtual method ReadString ()
type string
returns The data token value.
implements ISerializer.ReadString

ReadUInt16

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

public method ReadUInt16 ()
type int32
returns The read value.
implements IBinaryReader.ReadUInt16

Exceptions:

ReadUInt32

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

public method ReadUInt32 ()
type int64
returns The read value.
implements IBinaryReader.ReadUInt32

Exceptions:

ReadUInt8

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

public method ReadUInt8 ()
type int32
returns The read value.
implements IBinaryReader.ReadUInt8

Exceptions:

TryReadUInt8

Reads an unsigned 8-bit value from the stream.

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

Write

Writes a number of bytes to the stream.

public abstract method Write (ByteBuffer bytes)
params bytes [not-null] The bytes to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.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.
implements ISerializer.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.
implements ISerializer.WriteByteBuffer

WriteFloat32

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

public abstract method WriteFloat32 (float32 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteFloat32Array

WriteFloat32s

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

public abstract 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.
implements IBinaryWriter.WriteFloat32s

Exceptions:

WriteFloat64

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

public abstract method WriteFloat64 (float64 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteFloat64Array

WriteFloat64s

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

public abstract 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.
implements IBinaryWriter.WriteFloat64s

Exceptions:

WriteInt16

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

public abstract method WriteInt16 (int16 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteInt16Array

WriteInt16s

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

public abstract 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.
implements IBinaryWriter.WriteInt16s

Exceptions:

WriteInt32

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

public abstract method WriteInt32 (int32 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteInt32Array

WriteInt32s

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

public abstract 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.
implements IBinaryWriter.WriteInt32s

Exceptions:

WriteInt64

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

public abstract method WriteInt64 (int64 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteInt64Array

WriteInt64s

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

public abstract 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.
implements IBinaryWriter.WriteInt64s

Exceptions:

WriteInt8

Writes an 8-bit integer value to the stream.

public abstract method WriteInt8 (int8 value)
params value The value to write.
implements IBinaryWriter.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.
implements ISerializer.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.
implements ISerializer.WriteInt8Array

WriteInt8s

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

public abstract 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.
implements IBinaryWriter.WriteInt8s

Exceptions:

WriteObject

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

public abstract method WriteObject (ISerializable value)
params value The data token value.
implements ISerializer.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.
implements ISerializer.WriteString

Protected / Methods

ReadString

Returns a data token of the object being deserialized.

protected method ReadString (int32 length)
type string
params length The string length tag.
returns The data token value.
Tinman 3D SDK v1.0 | info@tinman3d.com | Copyright © 2012 - 2017 Matthias Englert, Fulda (Germany)