eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::ECallbackSerializer Class Reference

#include <eVision/Easy/ESerializer.h>

Inheritance diagram for eVision::ECallbackSerializer:
Collaboration diagram for eVision::ECallbackSerializer:

Public Member Functions

virtual ~ECallbackSerializer () throw ()
virtual eVision::ESerializerMode GetMode () const
 The current mode of the serializer.
virtual void Close ()
 Closes the ESerializer object and frees any underlying ressource it could have reserved.
virtual bool GetClosed () const
 Indicates if the ESerializer is closed or not.
 ECallbackSerializer (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::ESerializer
virtual ~ESerializer () throw ()
virtual bool GetWriting () const
 Returns true if the ESerializer object has been created for writing and false otherwise.
 ESerializer (CppWrapperInternal::InternalConstructor)

Additional Inherited Members

Static Public Member Functions inherited from eVision::ESerializer
static std::unique_ptr< eVision::ESerializer > CreateFileWriter (const std::string &filePath, eVision::ESerializerFileWriterMode mode)
 Returns an ESerializer object suitable for opening a file and writing into it.
static std::unique_ptr< eVision::ESerializer > CreateFileWriter (const std::string &filePath)
 Returns an ESerializer object suitable for opening a file and writing into it.
static std::unique_ptr< eVision::ESerializer > CreateFileReader (const std::string &filePath)
 Returns an ESerializer object suitable for reading from a file.
static std::unique_ptr< eVision::ESerializer > CreateMemoryWriter ()
 Returns an ESerializer object suitable for serializing into a buffer.
static std::unique_ptr< eVision::ESerializer > CreateMemoryWriter (uint32_t initialBufferSize)
 Returns an ESerializer object suitable for serializing into a buffer.
static std::unique_ptr< eVision::ESerializer > CreateMemoryWriter (void *buffer, uint32_t size)
 Returns an ESerializer object suitable for serializing into a buffer.
static std::unique_ptr< eVision::ESerializer > CreateMemoryReader (void *buffer, uint32_t size)
 Returns an ESerializer object suitable for reading from a buffer.
static std::unique_ptr< eVision::ESerializer > CreateMemoryReader (const std::vector< uint8_t > &bytes)
 Returns an ESerializer object suitable for reading from a buffer.
static std::unique_ptr< eVision::ESerializer > CreateCallbackWriter (void *isEOS, void *setCurrentPos, void *getCurrentPos, void *serializeMemory, void *close, void *cookie)
static std::unique_ptr< eVision::ESerializer > CreateCallbackReader (void *isEOS, void *setCurrentPos, void *getCurrentPos, void *serializeMemory, void *close, void *cookie)
Public Attributes inherited from eVision::ESerializer
CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

License(s): None

Constructor & Destructor Documentation

◆ ~ECallbackSerializer()

eVision::ECallbackSerializer::~ECallbackSerializer ( )
throw ( )
virtual

◆ ECallbackSerializer()

eVision::ECallbackSerializer::ECallbackSerializer ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Close()

void eVision::ECallbackSerializer::Close ( )
virtual

Closes the ESerializer object and frees any underlying ressource it could have reserved.

This method is always called implicitly during the destruction of the object. It is still recommended to call it explicitly in programming languages other than C++ to ensure the underlying ressources are correctly released.

This method never throws exceptions.

Reimplemented from eVision::ESerializer.

◆ GetClosed()

bool eVision::ECallbackSerializer::GetClosed ( ) const
virtual

Indicates if the ESerializer is closed or not.

Implements eVision::ESerializer.

◆ GetMode()

eVision::ESerializerMode eVision::ECallbackSerializer::GetMode ( ) const
virtual

The current mode of the serializer.

Implements eVision::ESerializer.