CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiDataExtractor Class Referenceabstract

#include <GiProgressiveMesh.h>

Public Member Functions

virtual bool registerDataBegin (OdUInt8 dataId, OdUInt64 localOffset)=0
 
virtual bool registerDataEnd (OdUInt8 dataId, OdUInt64 localOffset)=0
 
virtual OdUInt64 tell ()=0
 
virtual bool beginExtraction (OdUInt8 dataId)=0
 
virtual bool endExtraction (OdUInt8 dataId)=0
 
virtual bool seekFromLocalOffset (OdUInt64 offset)=0
 
virtual void extractBytes (void *buffer, OdUInt32 numBytes)=0
 
virtual double extractDouble ()
 
virtual OdInt32 extractInt64 ()
 
virtual OdInt32 extractInt32 ()
 
virtual OdInt16 extractInt16 ()
 
virtual OdUInt8 extractByte ()
 
virtual bool extractBool ()
 

Detailed Description

This interface provides data extraction API.

Definition at line 36 of file GiProgressiveMesh.h.

Member Function Documentation

◆ beginExtraction()

virtual bool OdGiDataExtractor::beginExtraction ( OdUInt8  dataId)
pure virtual

Initializes data extraction for the specified data type.

Parameters
dataId[in] Data identifier.
Returns
Returns true if operation is successful; otherwise returns false.

◆ endExtraction()

virtual bool OdGiDataExtractor::endExtraction ( OdUInt8  dataId)
pure virtual

Finalizes data extraction for the specified data type.

Parameters
dataId[in] Data identifier.
Returns
Returns true if operation is successful; otherwise returns false.

◆ extractBool()

virtual bool OdGiDataExtractor::extractBool ( )
virtual

Extracts boolean value.

Returns
Returns boolean value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ extractByte()

virtual OdUInt8 OdGiDataExtractor::extractByte ( )
virtual

Extracts byte value.

Returns
Returns byte value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ extractBytes()

virtual void OdGiDataExtractor::extractBytes ( void buffer,
OdUInt32  numBytes 
)
pure virtual

Extracts binary buffer.

Parameters
buffer[in] Pointer to the buffer.
numBytes[in] Buffer size.

◆ extractDouble()

virtual double OdGiDataExtractor::extractDouble ( )
virtual

Extracts double value.

Returns
Returns double value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ extractInt16()

virtual OdInt16 OdGiDataExtractor::extractInt16 ( )
virtual

Extracts 2-bytes integer value.

Returns
Returns 2-bytes integer value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ extractInt32()

virtual OdInt32 OdGiDataExtractor::extractInt32 ( )
virtual

Extracts 4-bytes integer value.

Returns
Returns 4-bytes integer value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ extractInt64()

virtual OdInt32 OdGiDataExtractor::extractInt64 ( )
virtual

Extracts 8-bytes integer value.

Returns
Returns 8-bytes integer value.
Remarks
This method has default implementation for the flat unpacked binary stream.

◆ registerDataBegin()

virtual bool OdGiDataExtractor::registerDataBegin ( OdUInt8  dataId,
OdUInt64  localOffset 
)
pure virtual

Registers the begin of data type by the specified local offset.

Parameters
dataId[in] Data identifier.
localOffset[in] Local data begin offset.
Returns
Returns true if operation is successful; otherwise returns false.

◆ registerDataEnd()

virtual bool OdGiDataExtractor::registerDataEnd ( OdUInt8  dataId,
OdUInt64  localOffset 
)
pure virtual

Registers the end of data type by the specified local offset.

Parameters
dataId[in] Data identifier.
localOffset[in] Local data end offset.
Returns
Returns true if operation is successful; otherwise returns false.

◆ seekFromLocalOffset()

virtual bool OdGiDataExtractor::seekFromLocalOffset ( OdUInt64  offset)
pure virtual

Moves extraction current position.

Parameters
offset[in] Move offset.
Returns
Returns true if operation is successful; otherwise returns false.

◆ tell()

virtual OdUInt64 OdGiDataExtractor::tell ( )
pure virtual

Retrives current extraction position.

Returns
Returns current extraction position.

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