SoGzipDataCompressor Class

Gzip data compression.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.LDM.CompressorsSoDataCompressor
      OIV.LDM.CompressorsSoGzipDataCompressor

Namespace: OIV.LDM.Compressors
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2025.2.0.0 (10.18.0.0)

Syntax

public class SoGzipDataCompressor : SoDataCompressor

Public Class SoGzipDataCompressor
	Inherits SoDataCompressor

public ref class SoGzipDataCompressor : public SoDataCompressor

type SoGzipDataCompressor =  
    class
        inherit SoDataCompressor
    end

The SoGzipDataCompressor type exposes the following members.

Constructors

	Name	Description
	SoGzipDataCompressor	Constructor.

Methods

	Name	Description
	AllocateCompressedBuffer	Allocates the internal buffer to hold the compressed data. (Inherited from SoDataCompressor.)
	Compress	Compresses the given buffer into the internal buffer. (Inherited from SoDataCompressor.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetCompressedBuffer	Returns the compressed data. (Inherited from SoDataCompressor.)
	GetCompressionFormatName	Returns the name of the compression algorithm used by this class. (Inherited from SoDataCompressor.)
	GetCompressionLevel	Returns the compression level. (Inherited from SoDataCompressor.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsLossless	Returns true if the compression algorithm is lossless. (Inherited from SoDataCompressor.)
	SetCompressionLevel	Sets the compression level. (Inherited from SoDataCompressor.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Uncompress	Uncompresses data from the internal buffer to the given buffer. (Inherited from SoDataCompressor.)

Remarks

This class implements a compression scheme based on zlib. It is a lossless compression and can be used on any data set type.

The setCompressionLevel method (inherited from OIV.LDM.Compressors.SoDataCompressor or in OIV.LDM.Converters.SoConverterParameters) accepts values between 0 and 9. 0 gives no compression, 9 gives best compression but slower speed. Default is 3.