BinaryArchiveReader

Public Class

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

Inheritance Hierarchy

System.Object
Rhino.FileIO.BinaryArchiveReader

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class BinaryArchiveReader

The BinaryArchiveReader type exposes the following members.

Properties

Name

Description

---

Public Property

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.

---

Public Property

CurrentPosition

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

---

Public Property

ReadErrorOccured

Gets or sets whether en error occurred during reading.

---

Methods

Name

Description

---

Public Method

AtEnd

true if at end of a file

---

Public Method

BeginRead3dmChunk(UInt32., Int64.)

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

---

Public Method

BeginRead3dmChunk(UInt32, Int32., Int32.)

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

---

Public Method

Dump3dmChunk

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.

---

Public Method

EnableCRCCalculation

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.

---

Public Method

EndRead3dmChunk

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

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

Read3dmChunkVersion

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.

---

Public Method

Read3dmStartSection

---

Public Method

ReadBool

Reads a Boolean from the archive.

---

Public Method

ReadBoolArray

Reads an array of Boolean from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadBoundingBox

Reads a BoundingBox from the archive.

---

Public Method

ReadByte

Reads a Byte from the archive.

---

Public Method

ReadByteArray

Reads an array of Byte from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadColor

Reads a Color from the archive.

---

Public Method

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.

---

Public Method

ReadDictionary

Reads a complete ArchivableDictionary from the archive.

---

Public Method

ReadDouble

Reads a Double from the archive.

---

Public Method

ReadDoubleArray

Reads an array of Double from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadFont

Reads a Font from the archive.

---

Public Method

ReadGeometry

Reads a GeometryBase-derived object from the archive.

The GeometryBase class is abstract.

---

Public Method

ReadGeometryArray

---

Public Method

ReadGuid

Reads a Guid from the archive.

---

Public Method

ReadGuidArray

Reads an array of Guid from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadInt

Reads a Int32 from the archive.

---

Public Method

ReadInt64

Reads a Int64 from the archive.

---

Public Method

ReadIntArray

Reads an array of Int32 from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadInterval

Reads a Interval from the archive.

---

Public Method

ReadLine

Reads a Line from the archive.

---

Public Method

ReadMeshingParameters

Reads a MeshingParameters from the archive.

---

Public Method

ReadObjRef

Reads a ObjRef from the archive

---

Public Method

ReadObjRefArray

Reads an array of Double from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadPlane

Reads a Plane from the archive.

---

Public Method

ReadPoint

Reads a Point from the archive.

---

Public Method

ReadPoint2d

Reads a Point2d from the archive.

---

Public Method

ReadPoint3d

Reads a Point3d from the archive.

---

Public Method

ReadPoint3f

Reads a Point3f from the archive.

---

Public Method

ReadPoint4d

Reads a Point4d from the archive.

---

Public Method

ReadPointF

Reads a PointF from the archive.

---

Public Method

ReadRay3d

Reads a Ray3d from the archive.

---

Public Method

ReadRectangle

Reads a Rectangle from the archive.

---

Public Method

ReadRectangleF

Reads a RectangleF from the archive.

---

Public Method

ReadRenderSettings

Reads a RenderSettings-derived object from the archive.

---

Public Method

ReadSByte

Reads a SByte from the archive.

---

Public Method

ReadSByteArray

Reads an array of SByte from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadShort

Reads a Int16 from the archive.

---

Public Method

ReadShortArray

Reads an array of Int16 from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadSingle

Reads a Single from the archive.

---

Public Method

ReadSingleArray

Reads an array of Single from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadSize

Reads a Size from the archive.

---

Public Method

ReadSizeF

Reads a SizeF from the archive.

---

Public Method

ReadString

Reads a String from the archive.

---

Public Method

ReadStringArray

Reads an array of String from the archive.

An array is returned even if the input was another enumerable type.

---

Public Method

ReadTransform

Reads a Transform from the archive.

---

Public Method

ReadUInt

Reads a UInt32 from the archive.

---

Public Method

ReadUShort

Reads a UInt16 from the archive.

---

Public Method

ReadUtf8String

Reads a String from the archive.

---

Public Method

ReadVector2d

Reads a Vector2d from the archive.

---

Public Method

ReadVector3d

Reads a Vector3d from the archive.

---

Public Method

ReadVector3f

Reads a Vector3f from the archive.

---

Public Method

SeekFromCurrentPosition(Int64)

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

---

Public Method

SeekFromCurrentPosition(UInt64, Boolean)

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

---

Public Method

SeekFromStart

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

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---