eVision.EMemorySerializer Class Reference

A type of eVision.ESerializer suitable for serialization and deserialization to and from memory buffers. More...

Inheritance diagram for eVision.EMemorySerializer:

Collaboration diagram for eVision.EMemorySerializer:

Public Member Functions
None	__init__ (self, eVision.ESerializerMode mode)
	Initializes an eVision.EMemorySerializer object in read or write mode.
None	__init__ (self, eVision.ESerializerMode mode, list[int] bytes)
	Initializes an eVision.EMemorySerializer object in read or write mode.
None	__init__ (self, eVision.ESerializerMode mode, ctypes.c_void_p externalBuffer, int externalBufferSize)
	Initializes an eVision.EMemorySerializer object in read or write mode.
None	SetMode (self, eVision.ESerializerMode mode)
	Sets the current mode of the eVision.EMemorySerializer.
None	Close (self)
	This method has no effect in eVision.EMemorySerializer.__init__.
eVision.ESerializerMode	Mode (self)
	The current mode of the serializer.
bool	Closed (self)
	Always false in eVision.EMemorySerializer.__init__.
ctypes.c_void_p	Buffer (self)
	Address of the internal buffer.
int	BufferSize (self)
	Size of the internal buffer.
list[int]	BufferAsVector (self)
	The internal buffer as a vector of bytes.
int	CurrentPosition (self)
	Current position in the buffer.
	CurrentPosition (self, int value)
	Current position in the buffer.
Public Member Functions inherited from eVision.ESerializer
bool	Writing (self)
	Returns true if the eVision.ESerializer object has been created for writing and false otherwise.

Additional Inherited Members
Static Public Member Functions inherited from eVision.ESerializer
eVision.ESerializer|None	CreateFileWriter (str filePath, eVision.ESerializerFileWriterMode mode)
	Returns an eVision.ESerializer object suitable for opening a file and writing into it.
eVision.ESerializer|None	CreateFileWriter (str filePath)
	Returns an eVision.ESerializer object suitable for opening a file and writing into it.
eVision.ESerializer|None	CreateFileReader (str filePath)
	Returns an eVision.ESerializer object suitable for reading from a file.
eVision.ESerializer|None	CreateMemoryWriter ()
	Returns an eVision.ESerializer object suitable for serializing into a buffer.
eVision.ESerializer|None	CreateMemoryWriter (int initialBufferSize)
	Returns an eVision.ESerializer object suitable for serializing into a buffer.
eVision.ESerializer|None	CreateMemoryWriter (ctypes.c_void_p buffer, int size)
	Returns an eVision.ESerializer object suitable for serializing into a buffer.
eVision.ESerializer|None	CreateMemoryReader (ctypes.c_void_p buffer, int size)
	Returns an eVision.ESerializer object suitable for reading from a buffer.
eVision.ESerializer|None	CreateMemoryReader (list[int] bytes)
	Returns an eVision.ESerializer object suitable for reading from a buffer.

Detailed Description

A type of eVision.ESerializer suitable for serialization and deserialization to and from memory buffers.

Remarks:

License(s): None

Constructor & Destructor Documentation

__init__() [1/3]

None eVision.EMemorySerializer.__init__	(		self,
		eVision.ESerializerMode	mode )

Initializes an eVision.EMemorySerializer object in read or write mode.

Remarks:

In read mode:

A buffer should be provided, either using a vector of bytes or an external buffer, in order to read the bytes from it.

In write mode:

If an external buffer is not provided, a internal buffer will be automatically created. In the case where an internal buffer is used that buffer will automatically be resized as needed during serialization operations.

Parameters

mode	The serializer mode, read or write.

__init__() [2/3]

None eVision.EMemorySerializer.__init__	(		self,
		eVision.ESerializerMode	mode,
		list[int]	bytes )

Initializes an eVision.EMemorySerializer object in read or write mode.

Remarks:

In read mode:

A buffer should be provided, either using a vector of bytes or an external buffer, in order to read the bytes from it.

In write mode:

If an external buffer is not provided, a internal buffer will be automatically created. In the case where an internal buffer is used that buffer will automatically be resized as needed during serialization operations.

Parameters

mode	The serializer mode, read or write.
bytes	A vector containing bytes to read. Can only be used in read mode.

Those bytes will be copied into eVision.EMemorySerializer's internal buffer.

__init__() [3/3]

None eVision.EMemorySerializer.__init__	(		self,
		eVision.ESerializerMode	mode,
		ctypes.c_void_p	externalBuffer,
		int	externalBufferSize )

Initializes an eVision.EMemorySerializer object in read or write mode.

Remarks:

In read mode:

A buffer should be provided, either using a vector of bytes or an external buffer, in order to read the bytes from it.

In write mode:

If an external buffer is not provided, a internal buffer will be automatically created. In the case where an internal buffer is used that buffer will automatically be resized as needed during serialization operations.

Parameters

mode	The serializer mode, read or write.
externalBuffer	Address of an external buffer to be used by the memory serializer.

Can be used in both read and write mode. When using an external buffer that buffer is not managed by eVision.EMemorySerializer. It is the responsability of the user to ensure this buffer is available during read and write operations.

Parameters

externalBufferSize

Must be specified if the buffer parameter is used. Size of the external memory buffer.

Member Function Documentation

Buffer()

ctypes.c_void_p eVision.EMemorySerializer.Buffer

(

self

)

Address of the internal buffer.

BufferAsVector()

list[int] eVision.EMemorySerializer.BufferAsVector

(

self

)

The internal buffer as a vector of bytes.

BufferSize()

int eVision.EMemorySerializer.BufferSize

(

self

)

Size of the internal buffer.

Close()

None eVision.EMemorySerializer.Close

(

self

)

This method has no effect in eVision.EMemorySerializer.__init__.

Reimplemented from eVision.ESerializer.

Closed()

bool eVision.EMemorySerializer.Closed

(

self

)

Always false in eVision.EMemorySerializer.__init__.

Reimplemented from eVision.ESerializer.

CurrentPosition() [1/2]

int eVision.EMemorySerializer.CurrentPosition

(

self

)

Current position in the buffer.

CurrentPosition() [2/2]

eVision.EMemorySerializer.CurrentPosition	(		self,
		int	value )

Current position in the buffer.

Mode()

eVision.ESerializerMode eVision.EMemorySerializer.Mode

(

self

)

The current mode of the serializer.

Reimplemented from eVision.ESerializer.

SetMode()

None eVision.EMemorySerializer.SetMode	(		self,
		eVision.ESerializerMode	mode )

Sets the current mode of the eVision.EMemorySerializer.

Calling this method also resets the position of the cursor in the serializer.

Parameters

mode

The mode