BinaryArchiveReader
ReferencesRepresents an entity that is capable of reading a binary archive and instantiating strongly-typed objects.
Properties
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.
current offset (in bytes) into archive ( like ftell() )
Methods
BeginRead3dmChunk
#Begins reading a chunk that must be in the archive at this location.
[CLSCompliant(false)]
public bool BeginRead3dmChunk(uint expectedTypeCode, out int majorVersion, out int minorVersion)
Begins reading a chunk that must be in the archive at this location.
Returns: True if beginning of the chunk was read. In this case you must call EndRead3dmChunk(), even if something goes wrong while you attempt to read the interior of the chunk. False if the chunk did not exist at the current location in the file.
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.
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.
Parameters:
| log (TextLog) | log where information is printed to |
Returns: 0 if something went wrong, otherwise the typecode of the chunk that was just studied.
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.
Parameters:
| enable (bool) |
Returns: Current state of CRC calculation. Use the returned value to restore the CRC calculation setting after you are finished doing your fancy pants expert IO.
Calling this will skip rest of stuff in chunk if it was only partially read.
Parameters:
| suppressPartiallyReadChunkWarning (bool) | Generally, a call to ON_WARNING is made when a chunk is partially read. If suppressPartiallyReadChunkWarning is true, then no warning is issued for partially read chunks. |
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.
Parameters:
| version (out int) | .3dm file version (2, 3, 4, 5 or 50) |
| comment (out string) | String with application name, et cetera. This information is primarily used when debugging files that contain problems. McNeel and Associates stores application name, application version, compile date, and the OS in use when file was written. |
Returns: true on success
Reads a bool from the archive.
Returns: The value that was read.
Reads an array of bool from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a BoundingBox from the archive.
Returns: The element that was read.
Reads a byte from the archive.
Returns: The value that was read.
Reads an array of byte from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
obsoleteThis is only present to allow reading of old ON_CheckSum data
Reads a legacy ON_CheckSum, only provided to read data chunks from old V5 files, the CheckSum read is discarded
Reads a Color from the archive.
Returns: The element that was read.
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.
Returns: The array that was read.
Reads a complete ArchivableDictionary from the archive.
Returns: The newly instantiated object.
Reads a double from the archive.
Returns: The value that was read.
Reads an array of double from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a Font from the archive.
Returns: The element that was read.
Reads a GeometryBase-derived object from the archive.
The GeometryBase class is abstract.
Returns: The element that was read.
Reads a Guid from the archive.
Returns: The value that was read.
Reads an array of Guid from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a int from the archive.
Returns: The value that was read.
Reads a long from the archive.
Returns: The value that was read.
Reads an array of int from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a Interval from the archive.
Returns: The element that was read.
Reads a Line from the archive.
Returns: The element that was read.
Reads a MeshingParameters from the archive.
Returns: The element that was read.
Reads a ObjRef from the archive
Returns: the element that was read
Reads an array of double from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a Plane from the archive.
Returns: The element that was read.
Reads a Point from the archive.
Returns: The element that was read.
Reads a Point2d from the archive.
Returns: The element that was read.
Reads a Point3d from the archive.
Returns: The element that was read.
Reads a Point3f from the archive.
Returns: The element that was read.
Reads a Point4d from the archive.
Returns: The element that was read.
Reads a PointF from the archive.
Returns: The element that was read.
Reads a Ray3d from the archive.
Returns: The element that was read.
Reads a Rectangle from the archive.
Returns: The element that was read.
Reads a RectangleF from the archive.
Returns: The element that was read.
Reads a RenderSettings-derived object from the archive.
Returns: The element that was read.
Reads a sbyte from the archive.
Returns: The value that was read.
Reads an array of sbyte from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a short from the archive.
Returns: The value that was read.
Reads an array of short from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a float from the archive.
Returns: The value that was read.
Reads an array of float from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a Size from the archive.
Returns: The element that was read.
Reads a SizeF from the archive.
Returns: The element that was read.
Reads a string from the archive.
Returns: The value that was read.
Reads an array of string from the archive.
An array is returned even if the input was another enumerable type.
Returns: The array that was read.
Reads a Transform from the archive.
Returns: The element that was read.
Reads a uint from the archive.
Returns: The value that was read.
Reads a ushort from the archive.
Returns: The value that was read.
Reads a string from the archive.
Returns: The value that was read.
Reads a Vector2d from the archive.
Returns: The element that was read.
Reads a Vector3d from the archive.
Returns: The element that was read.
Reads a Vector3f from the archive.
Returns: The element that was read.
SeekFromCurrentPosition
#seek from current position ( like fseek( ,SEEK_CUR) )
Parameters:
| byteOffset (long) |
SeekFromCurrentPosition
#seek from current position ( like fseek( ,SEEK_CUR) )