Skip to content
Gh doc lite

GH_IReader

Public Interface

Provides access to a subset of GH_Chunk methods used for reading archives.

Namespace: GH_IO.Serialization

Assembly: GH_IO (in GH_IO.dll)

Syntax

public interface GH_IReader : GH_IChunk,
  GH_IBinarySupport, GH_IXmlSupport

The GH_IReader type exposes the following members.

Properties

Name

Description

Public Property

Archive

Gets a pointer to the archive that owns the Root of the tree this chunk belongs to.

(Inherited from GH_IChunk.)

Public Property

ArchiveLocation

Gets a string representing the URI with which the archive is associated. The location may be a null string.

(Inherited from GH_IChunk.)

Public Property

ChunkCount

Gets the number of child chunks contained in this chunk. The set of all child chunks is referred to as a ‘litter’.

(Inherited from GH_IChunk.)

Public Property

Chunks

Gets a pointer to the internal list of child chunks. Do not access this list unless you know what you are doing.

(Inherited from GH_IChunk.)

Public Property

Index

Gets the index of this chunk. The index is set by the owner of this chunk. Indices smaller than zero imply no index has been set. The combination of name+index is always unique among a set of chunks in the same litter.

(Inherited from GH_IChunk.)

Public Property

ItemCount

Gets the number of items contained in this chunk.

(Inherited from GH_IChunk.)

Public Property

Items

Gets a pointer to the internal list of items. Do not access this list unless you know what you are doing.

(Inherited from GH_IChunk.)

Public Property

Name

Gets the name of this chunk. The name is set by the owner of this chunk. Names must be at least 1 character long. The combination of name+index is always unique among a set of chunks in a single litter.

(Inherited from GH_IChunk.)

Methods

Name

Description

Public Method

AddMessage

Log a new message with the top-level archive. Messages are collected during read/write operations, and can be displayed to the user upon completion using GH_Archive.ShowMessageLog().

(Inherited from GH_IChunk.)

Public Method

ChunkExists(String)

Checks whether a chunk with the specified name exists in the litter. Only chunks without index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

ChunkExists(String, Int32)

Checks whether a chunk with the specified name and index exists in the litter. Only chunks with index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

FindChunk(String)

Finds the first chunk in the litter that matches the given name. Only chunks without index qualifiers are considered.

Public Method

FindChunk(String, Int32)

Finds the first chunk in the list that matches the given name and index. Only chunks with index qualifiers are considered.

Public Method

FindItem(String)

Finds the first item that matches the given name. Only items without index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

FindItem(String, Int32)

Finds the first item that matches the given name and index. Only items with index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

GetBoolean(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetBoolean(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetBoundingBox(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetBoundingBox(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetByte(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetByte(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetByteArray(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetByteArray(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDate(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDate(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDecimal(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDecimal(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDouble(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDouble(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDoubleArray(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDoubleArray(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingBitmap(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingBitmap(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingColor(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingColor(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingPoint(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingPoint(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingPointF(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingPointF(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingRectangle(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingRectangle(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingRectangleF(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingRectangleF(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingSize(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingSize(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetDrawingSizeF(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetDrawingSizeF(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetGuid(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetGuid(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetInt32(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetInt32(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetInt64(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetInt64(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetInterval1D(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetInterval1D(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetInterval2D(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetInterval2D(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetLine(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetLine(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetPath(String, String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetPath(String, Int32, String)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetPlane(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetPlane(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetPoint2D(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetPoint2D(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetPoint3D(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetPoint3D(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetPoint4D(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetPoint4D(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetSingle(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetSingle(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetString(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetString(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

GetVersion(String)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

GetVersion(String, Int32)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

ItemExists(String)

Checks whether an item with the specified name exists. Only items without index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

ItemExists(String, Int32)

Checks whether an item with the specified name and index exists. Only items with index qualifiers are considered. Name comparisons are not case-sensitive.

Public Method

Read(BinaryReader)

Called when an object is required to deserialize itself.

(Inherited from GH_IBinarySupport.)

Public Method

Read(XmlNode)

Called when an object is required to deserialize itself.

(Inherited from GH_IXmlSupport.)

Public Method

TryGetBoolean(String, Boolean.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetBoolean(String, Int32, Boolean.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetBoundingBox(String, GH_BoundingBox.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetBoundingBox(String, Int32, GH_BoundingBox.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetByte(String, Byte.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetByte(String, Int32, Byte.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDate(String, DateTime.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDate(String, Int32, DateTime.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDecimal(String, Decimal.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDecimal(String, Int32, Decimal.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDouble(String, Double.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDouble(String, Int32, Double.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingColor(String, Color.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingColor(String, Int32, Color.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingPoint(String, Point.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingPoint(String, Int32, Point.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingPointF(String, PointF.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingPointF(String, Int32, PointF.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingRectangle(String, Rectangle.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingRectangle(String, Int32, Rectangle.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingRectangleF(String, RectangleF.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingRectangleF(String, Int32, RectangleF.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingSize(String, Size.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingSize(String, Int32, Size.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetDrawingSizeF(String, SizeF.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetDrawingSizeF(String, Int32, SizeF.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetGuid(String, Guid.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetGuid(String, Int32, Guid.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetInt32(String, Int32.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetInt32(String, Int32, Int32.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetInt64(String, Int64.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetInt64(String, Int32, Int64.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetInterval1D(String, GH_Interval1D.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetInterval1D(String, Int32, GH_Interval1D.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetInterval2D(String, GH_Interval2D.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetInterval2D(String, Int32, GH_Interval2D.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetLine(String, GH_Line.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetLine(String, Int32, GH_Line.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetPlane(String, GH_Plane.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetPlane(String, Int32, GH_Plane.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetPoint2D(String, GH_Point2D.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetPoint2D(String, Int32, GH_Point2D.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetPoint3D(String, GH_Point3D.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetPoint3D(String, Int32, GH_Point3D.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetPoint4D(String, GH_Point4D.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetPoint4D(String, Int32, GH_Point4D.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetSingle(String, Single.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetSingle(String, Int32, Single.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetString(String, String.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetString(String, Int32, String.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

TryGetVersion(String, GH_Version.)

Gets the value of the item with the specified name. Name comparison is not case-sensitive.

Public Method

TryGetVersion(String, Int32, GH_Version.)

Gets the value of the item with the specified name and index. Name comparison is not case-sensitive.

Public Method

Write(BinaryWriter)

Called when an object is required to serialize itself.

(Inherited from GH_IBinarySupport.)

Public Method

Write(XmlWriter)

Called when an object is required to serialize itself.

(Inherited from GH_IXmlSupport.)