DataFormatBaseWriterInterface Class Reference

#include <dataformat_base.h>

Inheritance diagram for DataFormatBaseWriterInterface:

详细描述

This class serializes data into IoStreams. It defines a file format for each data type.

公共成员函数

MAXON_METHOD Result < void >  CloseOutput ()
  MAXON_ADD_TO_REFERENCE_CLASS ( Result < void > ResetMaybeCloseOutput() { Result < void > res= OK ;if(this->GetPointer()) { if( System::GetReferenceCounter (this->GetPointer())==1) res=this->GetPointer() -> CloseOutput ();this->ResetReference();} return res;})
MAXON_METHOD Result < void >  WriteData (const void *data, Int dataSize, Int elementCount)
MAXON_METHOD Result < void >  Flush ()
template<typename T >
MAXON_FUNCTION Result < void >  Write (const Block < const T > &data)

私有成员函数

  MAXON_INTERFACE ( DataFormatBaseWriterInterface , MAXON_REFERENCE_NORMAL , "net.maxon.interface.dataformatbasewriter")

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( DataFormatBaseWriterInterface   ,
MAXON_REFERENCE_NORMAL   ,
"net.maxon.interface.dataformatbasewriter"   
)
private

◆  CloseOutput()

MAXON_METHOD Result <void> CloseOutput ( )

Close the stream and the stream handle.

返回
OK on success.

◆  MAXON_ADD_TO_REFERENCE_CLASS()

MAXON_ADD_TO_REFERENCE_CLASS ( Result < void > ResetMaybeCloseOutput() { Result < void > res= OK ;if(this->GetPointer()) { if( System::GetReferenceCounter (this->GetPointer())==1) res=this->GetPointer() -> CloseOutput ();this->ResetReference();} return res;}  )

◆  WriteData()

MAXON_METHOD Result <void> WriteData ( const void *  data ,
Int   dataSize ,
Int   elementCount  
)

Writes data to the stream and keeps the right byte order. If a Int64 is written into the stream on a little endian system it will be flipped when reading into a big endian system.

参数
[in] data Pointer to a memory address with the data.
[in] dataSize Size of the data to write. Possible sizes are 1 (without byte order changes) or 2, 4, 8 (with byte order correction).
[in] elementCount Number of data elements.
返回
OK on success.

◆  Flush()

MAXON_METHOD Result <void> Flush ( )

Flushes the output stream and forces any buffered output to be written.

返回
OK on success.

◆  Write()

MAXON_FUNCTION Result <void> Write ( const Block < const T > &  data )

Writes data to the stream and keeps the right byte order.

参数
[in] data 数据 to write into the stream.
返回
OK on success. @MAXON_ANNOTATION{returnsThis}