Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::ISerializedData Class Referenceabstract

Public Member Functions

virtual ~ISerializedData ()=default
 Frees resources.
virtual eDataType baseDataType () const =0
 Data type.
virtual Integer nbDimension () const =0
 Dimension. 0 for a scalar, 1 for a 1D array, ...
virtual Int64 nbElement () const =0
 Number of elements.
virtual Int64 nbBaseElement () const =0
 Number of base elements.
virtual bool isMultiSize () const =0
 Indicates if it is a multi-size array. (only relevant if nbDimension()>1).
virtual Int64 memorySize () const =0
 Indicates the number of bytes that must be allocated to store or read the data.
virtual Int64ConstArrayView extents () const =0
 Array containing the number of elements for each dimension.
virtual ArrayShape shape () const =0
 Shape of the array associated with the data.
virtual Span< const Byte > constBytes () const =0
 Serialized values.
virtual Span< Byte > writableBytes ()=0
 View of the serialized values.
virtual void setWritableBytes (Span< Byte > bytes)=0
 Positions the serialized values.
virtual void setConstBytes (Span< const Byte > bytes)=0
 Positions the serialized values for reading.
virtual void allocateMemory (Int64 size)=0
 Allocates an array to hold the serialized elements.
virtual void serialize (ISerializer *buffer)=0
 Serialize the data for reading or writing.
virtual void serialize (ISerializer *buffer) const =0
 Serialize the data for reading.
virtual void computeHash (IHashAlgorithm *algo, ByteArray &output) const =0
 Compute a hash key on this data.
 ARCANE_DEPRECATED_2018_R ("Use method 'writableBytes()' or 'constBytes()' instead") virtual ByteConstArrayView buffer() const =0
 Serialized values.
 ARCANE_DEPRECATED_2018_R ("Use method 'writableBytes()' or 'constBytes()' instead") virtual ByteArrayView buffer()=0
 Serialized values.
virtual Span< const Byte > bytes () const =0
 Serialized values.
virtual void setBuffer (ByteArrayView buffer)=0
 Positions the serialized values.
virtual void setBuffer (ByteConstArrayView buffer)=0
 Positions the serialized values.
virtual void setBytes (Span< Byte > bytes)=0
 Positions the serialized values.
virtual void setBytes (Span< const Byte > bytes)=0
 Positions the serialized values.
virtual Span< Byte > bytes ()=0
 Serialized values.

Detailed Description

Definition at line 62 of file ISerializedData.h.

Member Function Documentation

◆ allocateMemory()

virtual void Arcane::ISerializedData::allocateMemory ( Int64 size)
pure virtual

Allocates an array to hold the serialized elements.

After calling this method, it is possible to retrieve a view of the serialized values via writableBytes() or constBytes().

Implemented in Arcane::SerializedData.

◆ ARCANE_DEPRECATED_2018_R() [1/2]

Arcane::ISerializedData::ARCANE_DEPRECATED_2018_R ( "Use method 'writableBytes()' or 'constBytes()' instead" )
pure virtual

Serialized values.

Deprecated
Use bytes() instead.

References ARCANE_DEPRECATED_2018_R().

◆ ARCANE_DEPRECATED_2018_R() [2/2]

Arcane::ISerializedData::ARCANE_DEPRECATED_2018_R ( "Use method 'writableBytes()' or 'constBytes()' instead" ) const
pure virtual

Serialized values.

Deprecated
Use bytes() instead.

Referenced by ARCANE_DEPRECATED_2018_R().

◆ baseDataType()

virtual eDataType Arcane::ISerializedData::baseDataType ( ) const
pure virtual

Data type.

Implemented in Arcane::SerializedData.

◆ bytes() [1/2]

virtual Span< const Byte > Arcane::ISerializedData::bytes ( ) const
pure virtual

Serialized values.

Implemented in Arcane::SerializedData.

References bytes().

Referenced by bytes(), bytes(), setBytes(), setBytes(), setConstBytes(), and setWritableBytes().

◆ bytes() [2/2]

virtual Span< Byte > Arcane::ISerializedData::bytes ( )
pure virtual

Serialized values.

Warning
This method returns a non-empty view only if one has called setBytes(Span<Byte>) or allocateMemory().

Implemented in Arcane::SerializedData.

References Arcane::arcaneCreateEmptySerializedDataRef(), Arcane::arcaneCreateSerializedDataRef(), bytes(), and shape().

◆ computeHash()

virtual void Arcane::ISerializedData::computeHash ( IHashAlgorithm * algo,
ByteArray & output ) const
pure virtual

Compute a hash key on this data.

The key is added to output. The length of the key depends on the algorithm used.

Implemented in Arcane::SerializedData.

◆ constBytes()

virtual Span< const Byte > Arcane::ISerializedData::constBytes ( ) const
pure virtual

Serialized values.

Implemented in Arcane::SerializedData.

◆ extents()

virtual Int64ConstArrayView Arcane::ISerializedData::extents ( ) const
pure virtual

Array containing the number of elements for each dimension.

Implemented in Arcane::SerializedData.

◆ isMultiSize()

virtual bool Arcane::ISerializedData::isMultiSize ( ) const
pure virtual

Indicates if it is a multi-size array. (only relevant if nbDimension()>1).

Implemented in Arcane::SerializedData.

◆ memorySize()

virtual Int64 Arcane::ISerializedData::memorySize ( ) const
pure virtual

Indicates the number of bytes that must be allocated to store or read the data.

Implemented in Arcane::SerializedData.

◆ nbBaseElement()

virtual Int64 Arcane::ISerializedData::nbBaseElement ( ) const
pure virtual

Number of base elements.

Implemented in Arcane::SerializedData.

◆ nbDimension()

virtual Integer Arcane::ISerializedData::nbDimension ( ) const
pure virtual

Dimension. 0 for a scalar, 1 for a 1D array, ...

Implemented in Arcane::SerializedData.

◆ nbElement()

virtual Int64 Arcane::ISerializedData::nbElement ( ) const
pure virtual

Number of elements.

Implemented in Arcane::SerializedData.

◆ serialize() [1/2]

virtual void Arcane::ISerializedData::serialize ( ISerializer * buffer) const
pure virtual

Serialize the data for reading.

Implemented in Arcane::SerializedData.

◆ serialize() [2/2]

virtual void Arcane::ISerializedData::serialize ( ISerializer * buffer)
pure virtual

Serialize the data for reading or writing.

Implemented in Arcane::SerializedData.

◆ setBuffer() [1/2]

virtual void Arcane::ISerializedData::setBuffer ( ByteArrayView buffer)
pure virtual

Positions the serialized values.

The array buffer must not be modified as long as this instance is used.

Deprecated
Use setBytes() instead.

Implemented in Arcane::SerializedData.

References setBuffer().

Referenced by setBuffer(), and setBuffer().

◆ setBuffer() [2/2]

virtual void Arcane::ISerializedData::setBuffer ( ByteConstArrayView buffer)
pure virtual

Positions the serialized values.

The array buffer must not be modified as long as this instance is used.

Deprecated
Use setBytes() instead.

Implemented in Arcane::SerializedData.

References setBuffer().

◆ setBytes() [1/2]

virtual void Arcane::ISerializedData::setBytes ( Span< Byte > bytes)
pure virtual

Positions the serialized values.

The array bytes must not be modified as long as this instance is used.

Implemented in Arcane::SerializedData.

References bytes(), and setBytes().

Referenced by setBytes(), and setBytes().

◆ setBytes() [2/2]

virtual void Arcane::ISerializedData::setBytes ( Span< const Byte > bytes)
pure virtual

Positions the serialized values.

The array bytes must not be modified as long as this instance is used.

Implemented in Arcane::SerializedData.

References bytes(), and setBytes().

◆ setConstBytes()

virtual void Arcane::ISerializedData::setConstBytes ( Span< const Byte > bytes)
pure virtual

Positions the serialized values for reading.

The view bytes must remain valid as long as this instance is used.

Implemented in Arcane::SerializedData.

References bytes().

◆ setWritableBytes()

virtual void Arcane::ISerializedData::setWritableBytes ( Span< Byte > bytes)
pure virtual

Positions the serialized values.

The view bytes must remain valid as long as this instance is used.

Implemented in Arcane::SerializedData.

References bytes().

◆ shape()

virtual ArrayShape Arcane::ISerializedData::shape ( ) const
pure virtual

Shape of the array associated with the data.

Implemented in Arcane::SerializedData.

Referenced by bytes().

◆ writableBytes()

virtual Span< Byte > Arcane::ISerializedData::writableBytes ( )
pure virtual

View of the serialized values.

Warning
This method returns a non-empty view only if one has called allocateMemory() or setWritableBytes(Span<Byte>) beforehand.

Implemented in Arcane::SerializedData.

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