GH_IChunk

Public Interface

Base interface for all Archive Chunks.

Assembly: GH_IO (in GH_IO.dll)

Syntax

public interface GH_IChunk : GH_IBinarySupport,
  GH_IXmlSupport

The GH_IChunk 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.

Public Property

ArchiveLocation

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

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’.

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.

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.

Public Property

ItemCount

Gets the number of items contained in this chunk.

Public Property

Items

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

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.

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().

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

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.)