BinaryArchiveReader

BinaryArchiveReader class

Represents an entity that is capable of reading a binary archive and instantiating strongly-typed objects.

Derived Classes:

Namespace: Rhino.FileIO
BinaryArchiveReader: references

Properties (3)

Archive3dmVersion

If a 3dm archive is being read or written, then this is the version of the 3dm archive format (1, 2, 3, 4 or 5). 0 a 3dm archive is not being read/written 1 a version 1 3dm archive is being read/written 2 a version 2 3dm archive is being read/written 3 a version 3 3dm archive is being read/written 4 a version 4 3dm archive is being read/written 5 an old version 5 3dm archive is being read 50 a version 5 3dm archive is being read/written.

CurrentPosition

current offset (in bytes) into archive ( like ftell() )

ReadErrorOccured

Gets or sets whether en error occurred during reading.

Methods (63)

AtEnd()

True if at end of a file

BeginRead3dmChunk(out uint typeCode, out long value)

Begins reading a chunk that must be in the archive at this location.

BeginRead3dmChunk(uint expectedTypeCode, out int majorVersion, out int minorVersion)

Begins reading a chunk that must be in the archive at this location.

Dump3dmChunk(TextLog log)

Function for studying contents of a file. The primary use is as an aid to help dig through files that have been damaged (bad disks, transmission errors, etc.) If an error is found, a line that begins with the word "ERROR" is printed.

EnableCRCCalculation(bool enable)

Expert user function to control CRC calculation while reading and writing. Typically this is used when seeking around and reading/writing information in non-serial order.

EndRead3dmChunk(bool suppressPartiallyReadChunkWarning)

Calling this will skip rest of stuff in chunk if it was only partially read.

Read3dmChunkVersion(out int major, out int minor)

A chunk version is a single byte that encodes a major.minor version number. Useful when creating I/O code for 3dm chunks that may change in the future. Increment the minor version number if new information is added to the end of the chunk. Increment the major version if the format of the chunk changes in some other way.

Read3dmStartSection(out int version, out string comment)

ReadBool()

Reads a bool from the archive.

ReadBoolArray()

Reads an array of bool from the archive.
An array is returned even if the input was another enumerable type.

ReadBoundingBox()

Reads a Rhino.Geometry.BoundingBox from the archive.

ReadByte()

Reads a byte from the archive.

ReadByteArray()

Reads an array of byte from the archive.
An array is returned even if the input was another enumerable type.

ReadCheckSum()

Reads a legacy ON_CheckSum, only provided to read data chunks from old V5 files, the CheckSum read is discarded

ReadColor()

Reads a System.Drawing.Color from the archive.

ReadCompressedBuffer()

Reads an array of compressed byte information from the archive and uncompresses it.
An array is returned even if the input was another enumerable type.

ReadDictionary()

Reads a complete Rhino.Collections.ArchivableDictionary from the archive.

ReadDouble()

Reads a double from the archive.

ReadDoubleArray()

Reads an array of double from the archive.
An array is returned even if the input was another enumerable type.

ReadFont()

Reads a System.Drawing.Font from the archive.

ReadGeometry()

Reads a Rhino.Geometry.GeometryBase -derived object from the archive.
The class is abstract.

ReadGeometryArray()

ReadGuid()

Reads a Guid from the archive.

ReadGuidArray()

Reads an array of Guid from the archive.
An array is returned even if the input was another enumerable type.

ReadInt()

Reads a int from the archive.

ReadInt64()

Reads a long from the archive.

ReadIntArray()

Reads an array of int from the archive.
An array is returned even if the input was another enumerable type.

ReadInterval()

Reads a Rhino.Geometry.Interval from the archive.

ReadLine()

Reads a Rhino.Geometry.Line from the archive.

ReadMeshingParameters()

Reads a Rhino.Geometry.MeshingParameters from the archive.

ReadObjRef()

Reads a Rhino.DocObjects.ObjRef from the archive

ReadObjRefArray()

Reads an array of double from the archive.
An array is returned even if the input was another enumerable type.

ReadPlane()

Reads a Rhino.Geometry.Plane from the archive.

ReadPoint()

Reads a System.Drawing.Point from the archive.

ReadPoint2d()

Reads a Rhino.Geometry.Point2d from the archive.

ReadPoint3d()

Reads a Rhino.Geometry.Point3d from the archive.

ReadPoint3f()

Reads a Rhino.Geometry.Point3f from the archive.

ReadPoint4d()

Reads a Rhino.Geometry.Point4d from the archive.

ReadPointF()

Reads a System.Drawing.PointF from the archive.

ReadRay3d()

Reads a Rhino.Geometry.Ray3d from the archive.

ReadRectangle()

Reads a System.Drawing.Rectangle from the archive.

ReadRectangleF()

Reads a System.Drawing.RectangleF from the archive.

ReadRenderSettings()

Reads a Rhino.Render.RenderSettings -derived object from the archive.

ReadSByte()

Reads a sbyte from the archive.

ReadSByteArray()

Reads an array of sbyte from the archive.
An array is returned even if the input was another enumerable type.

ReadShort()

Reads a short from the archive.

ReadShortArray()

Reads an array of short from the archive.
An array is returned even if the input was another enumerable type.

ReadSingle()

Reads a float from the archive.

ReadSingleArray()

Reads an array of float from the archive.
An array is returned even if the input was another enumerable type.

ReadSize()

Reads a System.Drawing.Size from the archive.

ReadSizeF()

Reads a System.Drawing.SizeF from the archive.

ReadString()

Reads a string from the archive.

ReadStringArray()

Reads an array of string from the archive.
An array is returned even if the input was another enumerable type.

ReadTransform()

Reads a Rhino.Geometry.Transform from the archive.

ReadUInt()

Reads a uint from the archive.

ReadUShort()

Reads a ushort from the archive.

ReadUtf8String()

Reads a string from the archive.

ReadVector2d()

Reads a Rhino.Geometry.Vector2d from the archive.

ReadVector3d()

Reads a Rhino.Geometry.Vector3d from the archive.

ReadVector3f()

Reads a Rhino.Geometry.Vector3f from the archive.

SeekFromCurrentPosition(long byteOffset)

seek from current position ( like fseek( ,SEEK_CUR) )

SeekFromCurrentPosition(ulong byteOffset, bool forward)

seek from current position ( like fseek( ,SEEK_CUR) )

SeekFromStart(ulong byteOffset)

seek from start position ( like fseek( ,SEEK_SET) )

Nothing found