Open Search
    DataFormatBaseReaderInterface Class Reference

    #include <dataformat_base.h>

    Inheritance diagram for DataFormatBaseReaderInterface:

    Detailed Description

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

    Public Member Functions

    MAXON_METHOD Result< void > CloseInput ()
     
     MAXON_ADD_TO_REFERENCE_CLASS (Result< void > ResetMaybeCloseInput() { Result< void > res=OK;if(this->GetPointer()) { if(System::GetReferenceCounter(this->GetPointer())==1) res=this->GetPointer() ->CloseInput();this->ResetReference();} return res;})
     
    MAXON_FUNCTION Result< void > ReadData (void *data, Int dataSize, Int elementCount)
     
    MAXON_METHOD Result< IntReadDataEOS (void *data, Int dataSize, Int elementCount)
     

    Private Member Functions

     MAXON_INTERFACE (DataFormatBaseReaderInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.dataformatbasereader", MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel"))
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( DataFormatBaseReaderInterface  ,
    MAXON_REFERENCE_NORMAL  ,
    "net.maxon.interface.dataformatbasereader"  ,
    MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel")   
    )
    private

    ◆ CloseInput()

    MAXON_METHOD Result<void> CloseInput ( )

    Close the stream and the stream handle.

    Returns
    OK on success.

    ◆ MAXON_ADD_TO_REFERENCE_CLASS()

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

    ◆ ReadData()

    MAXON_FUNCTION Result<void> ReadData ( void *  data,
    Int  dataSize,
    Int  elementCount 
    )

    Reads data from the stream and keeps the right byte order. E.g. if a Int64 is written into the stream on a little endian system it will be flipped when reading into a big endian system.

    Parameters
    [in]dataPointer to a memory address with the data.
    [in]dataSizeSize of the data to write. Possible sizes are 1 (without byte order changes) or 2, 4, 8 (with byte order correction).
    [in]elementCountNumber of data elements.
    Returns
    OK on success.

    ◆ ReadDataEOS()

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

    Reads data from the stream and keeps the right byte order. E.g. if a Int64 is written into the stream on a little endian system it will be flipped when reading into a big endian system.

    Parameters
    [in]dataPointer to a memory address with the data.
    [in]dataSizeSize of the data to write. Possible sizes are 1 (without byte order changes) or 2, 4, 8 (with byte order correction).
    [in]elementCountNumber of data elements.
    Returns
    Returns the number of elements (not bytes) that have been read.