GH_IWriter
Provides access to a subset of GH_Chunk methods used for writing archives.
Namespace: GH_IO.Serialization
Assembly: GH_IO (in GH_IO.dll)
Syntax
public interface GH_IWriter : GH_IChunk, GH_IBinarySupport, GH_IXmlSupportThe GH_IWriter 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
AddComment
Adds a text comment to this chunk. Comments are serialized only if the output flavour is a human readable format. Comments are never deserialized, they are purely for the benefit of the humans reading the file data.
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
CreateChunk(String)
Create a new child chunk with the specified name but without an index qualifier. If another chunk already exists with similar properties, an exception will be thrown.
Public Method
CreateChunk(String, Int32)
Create a new child chunk with the specified name and index qualifier. If another chunk already exists with similar properties, an exception will be thrown.
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
RemoveChunk(GH_IChunk)
Remove the specified chunk from the litter.
Public Method
RemoveChunk(String)
Remove the first chunk with a matching name. Only chunks without index qualifiers are considered. Name comparisons are not case-sensitive.
Public Method
RemoveChunk(String, Int32)
Remove the first chunk with a matching name and index. Only chunks with index qualifiers are considered. Name comparisons are not case-sensitive.
Public Method
RemoveItem(String)
Remove an unindexed item from this chunk.
Public Method
RemoveItem(String, Int32)
Remove an indexed item from this chunk.
Public Method
SetBoolean(String, Boolean)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetBoolean(String, Int32, Boolean)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetBoundingBox(String, GH_BoundingBox)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetBoundingBox(String, Int32, GH_BoundingBox)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetByte(String, Byte)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetByte(String, Int32, Byte)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetByteArray(String, .Byte.)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetByteArray(String, Int32, .Byte.)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDate(String, DateTime)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDate(String, Int32, DateTime)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDecimal(String, Decimal)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDecimal(String, Int32, Decimal)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDouble(String, Double)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDouble(String, Int32, Double)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDoubleArray(String, .Double.)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDoubleArray(String, Int32, .Double.)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingBitmap(String, Bitmap)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingBitmap(String, Int32, Bitmap)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingColor(String, Color)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingColor(String, Int32, Color)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingPoint(String, Point)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingPoint(String, Int32, Point)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingPointF(String, PointF)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingPointF(String, Int32, PointF)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingRectangle(String, Rectangle)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingRectangle(String, Int32, Rectangle)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingRectangleF(String, RectangleF)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingRectangleF(String, Int32, RectangleF)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingSize(String, Size)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingSize(String, Int32, Size)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetDrawingSizeF(String, SizeF)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetDrawingSizeF(String, Int32, SizeF)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetGuid(String, Guid)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetGuid(String, Int32, Guid)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetInt32(String, Int32)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetInt32(String, Int32, Int32)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetInt64(String, Int64)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetInt64(String, Int32, Int64)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetInterval1D(String, GH_Interval1D)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetInterval1D(String, Int32, GH_Interval1D)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetInterval2D(String, GH_Interval2D)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetInterval2D(String, Int32, GH_Interval2D)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetLine(String, GH_Line)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetLine(String, Int32, GH_Line)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPath(String, String, String)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPath(String, Int32, String, String)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPlane(String, GH_Plane)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetPlane(String, Int32, GH_Plane)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPoint2D(String, GH_Point2D)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetPoint2D(String, Int32, GH_Point2D)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPoint3D(String, GH_Point3D)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetPoint3D(String, Int32, GH_Point3D)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetPoint4D(String, GH_Point4D)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetPoint4D(String, Int32, GH_Point4D)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetSingle(String, Single)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetSingle(String, Int32, Single)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetString(String, String)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetString(String, Int32, String)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetVersion(String, GH_Version)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetVersion(String, Int32, GH_Version)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
Public Method
SetVersion(String, Int32, Int32, Int32)
Add a new data item to this chunk. The name must be unique or an exception will be thrown.
Public Method
SetVersion(String, Int32, Int32, Int32, Int32)
Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.
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.)