C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

List of all members
DataArchiveIface Class Referenceabstract

Abstract interface class that defines methods to access and modify a serialized object. This class declares the most generic access and modification methods. More...

Class Declaration

Member Function Documentation

virtual size_t copyArchiveToArray ( byte *  ptr,
size_t  maxLength 
) const
pure virtual

Copies a data archive in the byte format to user-specified memory

Parameters
[in]ptrPointer to the byte array
[in]maxLengthSize of the array
Returns
Actual size of the data archive in bytes

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual DAAL_DEPRECATED_VIRTUAL byte* getArchiveAsArray ( )
inlinevirtual

Returns a data archive in the byte format

Returns
Pointer to the byte buffer with the archive data
Deprecated:
This item will be removed in a future release. Use DataArchiveIface::getArchiveAsArraySharedPtr instead.

Reimplemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual services::SharedPtr<byte> getArchiveAsArraySharedPtr ( ) const
pure virtual

Returns a data archive in the byte format

Returns
Pointer to the byte buffer with the archive data

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual DAAL_DEPRECATED_VIRTUAL std::string getArchiveAsString ( )
pure virtual

Returns a data archive in the STL string format

Returns
Object of the std::string type with the archive data
Deprecated:
This item will be removed in a future release.

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual int getMajorVersion ( )
pure virtual

Returns the major version of the archive

Returns
The major version of the archive

Implemented in DataArchiveImpl.

virtual int getMinorVersion ( )
pure virtual

Returns the minor version of the archive

Returns
The minor version of the archive

Implemented in DataArchiveImpl.

virtual size_t getSizeOfArchive ( ) const
pure virtual

Returns the size of an archive

Returns
Size of the archive in bytes

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual int getUpdateVersion ( )
pure virtual

Returns the update version of the archive

Returns
The update version of the archive

Implemented in DataArchiveImpl.

virtual void read ( byte *  ptr,
size_t  size 
)
pure virtual

Copies the content of an archive into a byte array

Parameters
[in]ptrPointer to the array that represents the data
[in]sizeSize of the data array

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.

virtual void setMajorVersion ( int  majorVersion)
pure virtual

Sets the major version of the archive

Parameters
[in]majorVersionThe major version of the archive

Implemented in DataArchiveImpl.

virtual void setMinorVersion ( int  minorVersion)
pure virtual

Sets the minor version of the archive

Parameters
[in]minorVersionThe minor version of the archive

Implemented in DataArchiveImpl.

virtual void setUpdateVersion ( int  updateVersion)
pure virtual

Sets the update version of the archive

Parameters
[in]updateVersionThe update version of the archive

Implemented in DataArchiveImpl.

virtual void write ( byte *  ptr,
size_t  size 
)
pure virtual

Copies data into an archive

Parameters
[in]ptrPointer to the data represented in the byte format
[in]sizeSize of the data array

Implemented in DecompressedDataArchive, CompressedDataArchive, and DataArchive.


The documentation for this class was generated from the following file:

For more complete information about compiler optimizations, see our Optimization Notice.