GH_Chunk

GH_LooseChunk

public class GH_Chunk : GH_IWriter, GH_IReader

Full implementation of GH_IChunk, GH_IReader, GH_IWriter, GH_IBinarySupport and GH_IXmlSupport. Instances of this class are usually disguised as one of the interfaces it implements.

Constructors

GH_Chunk

protected GH_Chunk()

Blank constructor. You typically do not need to create your own Chunks. The GH_Archive class will create top-level chunks and existing chunks can create child chunks.

GH_Chunk

protected GH_Chunk(GH_Archive chunk_archive, string chunk_name, int chunk_index)

Constructor. You typically do not need to create your own Chunks. The GH_Archive class will create top-level chunks and existing chunks can create child chunks.

Parameters:

chunk_archive (GH_Archive)	Owner archive.
chunk_name (string)	Name of this chunk.
chunk_index (int)	Index of this chunk.

GH_Chunk

protected GH_Chunk(GH_Archive chunk_archive, string chunk_name)

Constructor. You typically do not need to create your own Chunks. The GH_Archive class will create top-level chunks and existing chunks can create child chunks.

Parameters:

chunk_archive (GH_Archive)	Owner archive.
chunk_name (string)	Name of this chunk.

GH_Chunk

protected GH_Chunk(GH_Archive chunk_archive)

Constructor. You typically do not need to create your own Chunks. The GH_Archive class will create top-level chunks and existing chunks can create child chunks.

Parameters:

chunk_archive (GH_Archive)

Owner archive.

Fields

m_archive

protected GH_Archive m_archive

Pointer to the archive that owns the Root of the tree this chunk belongs to.

m_chunks

protected GH_Chunk.ChunkKeyedCollection m_chunks

Dictionary of sub-chunks contained within this chunk.

m_comments

protected List<string> m_comments

List of text comments. This list is automatically instantiated once the first comment is added.

m_index

protected int m_index

Index of this chunk. This field is set only once, during construction. A negative index indicates no index qualifier has been set.

m_items

protected SortedDictionary<ID, GH_Item> m_items

The list of nodes contained within this chunk.

m_name

protected string m_name

Name of this chunk. This field is set only once, during construction.

name_comp

protected static StringComparison name_comp

Comparison flag to use when comparing names.

Properties

ArchiveLocation

public string ArchiveLocation { get; }

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

Implements: ArchiveLocation

ChunkCount

public int ChunkCount { get; }

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

Implements: ChunkCount

Chunks

public List<GH_IChunk> Chunks { get; }

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

Implements: Chunks

HasComments

public bool HasComments { get; }

Gets a value that indicates whether or not comments have been stored in this chunk.

HasIndex

public bool HasIndex { get; }

Gets the index existence implication. The item is considered to have an index qualifier if the index value is larger than or equal to zero.

HasName

public bool HasName { get; }

Gets the name validity of this item. The item is considered to have an invalid name if string.IsNullOrEmpty(name)

Index

public int Index { get; }

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.

Implements: Index

ItemCount

public int ItemCount { get; }

Gets the number of items contained in this chunk.

Implements: ItemCount

Items

public List<GH_Item> Items { get; }

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

Implements: Items

Name

public string Name { get; }

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.

Implements: Name

Methods

AddComment

public void AddComment(string comment_text)

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.

Parameters:

comment_text (string)

The content of the comment, text might be altered if it contains invalid characters for a chosen format flavour.

Exceptions:

ArgumentNullException

Thrown if the content text is either null or empty.

Implements: AddComment

AddMessage

public void AddMessage(string m, GH_Message_Type t)

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

Parameters:

m (string)	Message text.
t (GH_Message_Type)	Message type.

Exceptions:

ArgumentNullException

Thrown if message text is null or empty.

Implements: AddMessage

ChunkExists

public bool ChunkExists(string name, int index)

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.

Parameters:

name (string)	Name of chunk to test for.
index (int)	Index of chunk to test for. If less than zero, ChunkExists(string name) is called instead.

Returns: True if a chunk with the specified name and index exists, otherwise false.

Implements: ChunkExists

ChunkExists

public bool ChunkExists(string name)

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.

Parameters:

name (string)

Name of chunk to test for.

Returns: True if a chunk with the specified name exists, otherwise false.

Implements: ChunkExists

CopyValuesFromChunk

public void CopyValuesFromChunk(GH_Chunk other)

Copy all values and sub-chunks from another chunk.

Parameters:

other (GH_Chunk)

CopyValuesToChunk

public GH_Chunk CopyValuesToChunk()

Copy all values and sub-chunks in this chunk to another chunk which does not point to the same archive.

CreateChunk

public GH_IWriter CreateChunk(string chunk_name, int chunk_index)

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.

Parameters:

chunk_name (string)	Name of new child.
chunk_index (int)	Index of new child.

Returns: The newly created child chunk.

Exceptions:

ArgumentException

Thrown if the name+index coordinte is already occupied by another chunk.

Implements: CreateChunk

CreateChunk

public GH_IWriter CreateChunk(string chunk_name)

Create a new child chunk with the specified name and without an index qualifier. If another chunk already exists with similar properties, an exception will be thrown.

Parameters:

chunk_name (string)

Name of new child.

Returns: The newly created child chunk.

Exceptions:

ArgumentException

Thrown if the name+index coordinte is already occupied by another chunk.

Implements: CreateChunk

FindChunk

public GH_IReader FindChunk(string name, int index)

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

Parameters:

name (string)	Name of chunk to search for.
index (int)	Index of chunk to search for. If less than zero, FindChunk(string chunk_name) is called instead.

Returns: The child chunk that matches the given name and index, or null of no matching chunk could be found.

Implements: FindChunk

FindChunk

public GH_IReader FindChunk(string name)

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

Parameters:

name (string)

Name of chunk to search for.

Returns: The child chunk that matches the given name, or null of no matching chunk could be found.

Implements: FindChunk

FindItem

public GH_Item FindItem(string name, int index)

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

Parameters:

name (string)	Name of item to search for.
index (int)	Index of item to search for. If less than zero, then FindItem(string name) is called instead.

Returns: The item that matches the given name and index, or null of no matching item could be found.

Implements: FindItem

FindItem

public GH_Item FindItem(string name)

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

Parameters:

name (string)

Name of item to search for.

Returns: The item that matches the given name, or null of no matching item could be found.

Implements: FindItem

GetBoolean

public bool GetBoolean(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetBoolean

GetBoolean

public bool GetBoolean(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetBoolean

GetBoundingBox

public GH_BoundingBox GetBoundingBox(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetBoundingBox

GetBoundingBox

public GH_BoundingBox GetBoundingBox(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetBoundingBox

GetByte

public byte GetByte(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetByte

GetByte

public byte GetByte(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetByte

GetByteArray

public byte[] GetByteArray(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetByteArray

GetByteArray

public byte[] GetByteArray(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetByteArray

GetDate

public DateTime GetDate(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDate

GetDate

public DateTime GetDate(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDate

GetDecimal

public decimal GetDecimal(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDecimal

GetDecimal

public decimal GetDecimal(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDecimal

GetDouble

public double GetDouble(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDouble

GetDouble

public double GetDouble(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDouble

GetDoubleArray

public double[] GetDoubleArray(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDoubleArray

GetDoubleArray

public double[] GetDoubleArray(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDoubleArray

GetDrawingBitmap

public Bitmap GetDrawingBitmap(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingBitmap

GetDrawingBitmap

public Bitmap GetDrawingBitmap(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingBitmap

GetDrawingColor

public Color GetDrawingColor(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingColor

GetDrawingColor

public Color GetDrawingColor(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingColor

GetDrawingPoint

public Point GetDrawingPoint(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingPoint

GetDrawingPoint

public Point GetDrawingPoint(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingPoint

GetDrawingPointF

public PointF GetDrawingPointF(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingPointF

GetDrawingPointF

public PointF GetDrawingPointF(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingPointF

GetDrawingRectangle

public Rectangle GetDrawingRectangle(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingRectangle

GetDrawingRectangle

public Rectangle GetDrawingRectangle(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingRectangle

GetDrawingRectangleF

public RectangleF GetDrawingRectangleF(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingRectangleF

GetDrawingRectangleF

public RectangleF GetDrawingRectangleF(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingRectangleF

GetDrawingSize

public Size GetDrawingSize(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingSize

GetDrawingSize

public Size GetDrawingSize(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingSize

GetDrawingSizeF

public SizeF GetDrawingSizeF(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetDrawingSizeF

GetDrawingSizeF

public SizeF GetDrawingSizeF(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetDrawingSizeF

GetGuid

public Guid GetGuid(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetGuid

GetGuid

public Guid GetGuid(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetGuid

GetInt32

public int GetInt32(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetInt32

GetInt32

public int GetInt32(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetInt32

GetInt64

public long GetInt64(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetInt64

GetInt64

public long GetInt64(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetInt64

GetInterval1D

public GH_Interval1D GetInterval1D(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetInterval1D

GetInterval1D

public GH_Interval1D GetInterval1D(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetInterval1D

GetInterval2D

public GH_Interval2D GetInterval2D(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetInterval2D

GetInterval2D

public GH_Interval2D GetInterval2D(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetInterval2D

GetLine

public GH_Line GetLine(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetLine

GetLine

public GH_Line GetLine(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetLine

GetPath

public string[] GetPath(string item_name, int item_index, string basePath)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
basePath (string)	Base path for relative path resolution.

Returns: An array of path strings. If the resolved relative path is different from the stored absolute path, an array of two strings will be returned [absolute, relative].

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetPath

GetPath

public string[] GetPath(string item_name, string basePath)

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

Parameters:

item_name (string)	Name of item to retrieve.
basePath (string)	Base path for relative path resolution.

Returns: An array of path strings. If the resolved relative path is different from the stored absolute path, an array of two strings will be returned [absolute, relative].

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetPath

GetPlane

public GH_Plane GetPlane(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetPlane

GetPlane

public GH_Plane GetPlane(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetPlane

GetPoint2D

public GH_Point2D GetPoint2D(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetPoint2D

GetPoint2D

public GH_Point2D GetPoint2D(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetPoint2D

GetPoint3D

public GH_Point3D GetPoint3D(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetPoint3D

GetPoint3D

public GH_Point3D GetPoint3D(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetPoint3D

GetPoint4D

public GH_Point4D GetPoint4D(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetPoint4D

GetPoint4D

public GH_Point4D GetPoint4D(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetPoint4D

GetSingle

public float GetSingle(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetSingle

GetSingle

public float GetSingle(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetSingle

GetString

public string GetString(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetString

GetString

public string GetString(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetString

GetVersion

public GH_Version GetVersion(string item_name, int item_index)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name and index does not exist.

Implements: GetVersion

GetVersion

public GH_Version GetVersion(string item_name)

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

Parameters:

item_name (string)

Name of item to retrieve.

Returns: The inner value of the item.

Exceptions:

OverflowException	Thrown if the type conversion fails.
InvalidCastException	Thrown if the type conversion is invalid.
NullReferenceException	Thrown if the item with the specified name does not exist.

Implements: GetVersion

InstantiateRoot

public static GH_Chunk InstantiateRoot(GH_Archive owner)

Construct a new instance of GH_Chunk which acts as a Root node. If you must create a chunk from scratch, use this static method to create one.

Parameters:

owner (GH_Archive)

The archive which owns this chunk.

Exceptions:

ArgumentNullException

Thrown when the owner is a null reference.

ItemExists

public bool ItemExists(string name, int index)

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

Parameters:

name (string)	Name of item to test for.
index (int)	Index of item to test for. If index is less than zero, then ItemExists(string name) is called instead.

Returns: True if an item with the specified name and index exists, otherwise false.

Implements: ItemExists

ItemExists

public bool ItemExists(string name)

Gets the occupancy for a specific item name. Only items without index qualifiers are considered.

Parameters:

name (string)

Name of item to check for.

Returns: True if an item with a similar name already exists, false if not.

Implements: ItemExists

Read

public void Read(BinaryReader reader)

Read this chunk and all child chunks from a binary stream.

Parameters:

reader (BinaryReader)

The Binary reader to use, cannot be null.

Implements: Read

Read

public void Read(XmlNode node)

Read this chunk and all child chunks from an Xml node.

Parameters:

node (XmlNode)

The Xml node to deserialize from, cannot be null.

Implements: Read

RemoveChunk

public bool RemoveChunk(GH_IChunk chunk)

Remove the specified chunk from the litter.

Parameters:

chunk (GH_IChunk)

Chunk to remove.

Returns: True is chunk was removed, false if chunk is not part of this litter.

Exceptions:

ArgumentNullException

Thrown if chunk is a null reference.

Implements: RemoveChunk

RemoveChunk

public bool RemoveChunk(string chunk_name, int chunk_index)

Remove the first chunk with a matching name and index. Only chunks with index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

chunk_name (string)	Name of chunk to remove.
chunk_index (int)	Index of chunk to remove.

Returns: True is chunk was removed, false if no matching chunk could be found.

Implements: RemoveChunk

RemoveChunk

public bool RemoveChunk(string chunk_name)

Remove the first chunk with a matching name. Only chunks without index qualifiers are considered. Name comparisons are not case-sensitive.

Parameters:

chunk_name (string)

Name of chunk to remove.

Returns: True is chunk was removed, false if no matching chunk could be found.

Implements: RemoveChunk

RemoveItem

public bool RemoveItem(string itemName, int itemIndex)

Remove an indexed item from this chunk.

Parameters:

itemName (string)	Name of item.
itemIndex (int)	Index of item.

Returns: True on success, false on failure.

Implements: RemoveItem

RemoveItem

public bool RemoveItem(string itemName)

Remove an unindexed item from this chunk.

Parameters:

itemName (string)

Name of item.

Returns: True on success, false on failure.

Implements: RemoveItem

SetBoolean

public void SetBoolean(string item_name, bool item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (bool)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetBoolean

SetBoolean

public void SetBoolean(string item_name, int item_index, bool item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (bool)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetBoolean

SetBoundingBox

public void SetBoundingBox(string item_name, GH_BoundingBox item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_BoundingBox)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetBoundingBox

SetBoundingBox

public void SetBoundingBox(string item_name, int item_index, GH_BoundingBox item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_BoundingBox)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetBoundingBox

SetByte

public void SetByte(string item_name, byte item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (byte)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetByte

SetByte

public void SetByte(string item_name, int item_index, byte item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (byte)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetByte

SetByteArray

public void SetByteArray(string item_name, byte[] item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (byte[])	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetByteArray

SetByteArray

public void SetByteArray(string item_name, int item_index, byte[] item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (byte[])	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetByteArray

SetDate

public void SetDate(string item_name, DateTime item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (DateTime)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDate

SetDate

public void SetDate(string item_name, int item_index, DateTime item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (DateTime)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDate

SetDecimal

public void SetDecimal(string item_name, decimal item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (decimal)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDecimal

SetDecimal

public void SetDecimal(string item_name, int item_index, decimal item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (decimal)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDecimal

SetDouble

public void SetDouble(string item_name, double item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (double)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDouble

SetDouble

public void SetDouble(string item_name, int item_index, double item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (double)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDouble

SetDoubleArray

public void SetDoubleArray(string item_name, double[] item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (double[])	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDoubleArray

SetDoubleArray

public void SetDoubleArray(string item_name, int item_index, double[] item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (double[])	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDoubleArray

SetDrawingBitmap

public void SetDrawingBitmap(string item_name, Bitmap item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Bitmap)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingBitmap

SetDrawingBitmap

public void SetDrawingBitmap(string item_name, int item_index, Bitmap item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Bitmap)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingBitmap

SetDrawingColor

public void SetDrawingColor(string item_name, Color item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Color)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingColor

SetDrawingColor

public void SetDrawingColor(string item_name, int item_index, Color item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Color)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingColor

SetDrawingPoint

public void SetDrawingPoint(string item_name, int item_index, Point item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Point)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingPoint

SetDrawingPoint

public void SetDrawingPoint(string item_name, Point item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Point)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingPoint

SetDrawingPointF

public void SetDrawingPointF(string item_name, int item_index, PointF item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (PointF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingPointF

SetDrawingPointF

public void SetDrawingPointF(string item_name, PointF item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (PointF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingPointF

SetDrawingRectangle

public void SetDrawingRectangle(string item_name, int item_index, Rectangle item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Rectangle)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingRectangle

SetDrawingRectangle

public void SetDrawingRectangle(string item_name, Rectangle item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Rectangle)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingRectangle

SetDrawingRectangleF

public void SetDrawingRectangleF(string item_name, int item_index, RectangleF item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (RectangleF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingRectangleF

SetDrawingRectangleF

public void SetDrawingRectangleF(string item_name, RectangleF item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (RectangleF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingRectangleF

SetDrawingSize

public void SetDrawingSize(string item_name, int item_index, Size item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Size)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingSize

SetDrawingSize

public void SetDrawingSize(string item_name, Size item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Size)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingSize

SetDrawingSizeF

public void SetDrawingSizeF(string item_name, int item_index, SizeF item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (SizeF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetDrawingSizeF

SetDrawingSizeF

public void SetDrawingSizeF(string item_name, SizeF item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (SizeF)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetDrawingSizeF

SetGuid

public void SetGuid(string item_name, Guid item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (Guid)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetGuid

SetGuid

public void SetGuid(string item_name, int item_index, Guid item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (Guid)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetGuid

SetInt32

public void SetInt32(string item_name, int item_index, int item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (int)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetInt32

SetInt32

public void SetInt32(string item_name, int item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (int)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetInt32

SetInt64

public void SetInt64(string item_name, int item_index, long item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (long)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetInt64

SetInt64

public void SetInt64(string item_name, long item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (long)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetInt64

SetInterval1D

public void SetInterval1D(string item_name, GH_Interval1D item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Interval1D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetInterval1D

SetInterval1D

public void SetInterval1D(string item_name, int item_index, GH_Interval1D item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Interval1D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetInterval1D

SetInterval2D

public void SetInterval2D(string item_name, GH_Interval2D item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Interval2D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetInterval2D

SetInterval2D

public void SetInterval2D(string item_name, int item_index, GH_Interval2D item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Interval2D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetInterval2D

SetLine

public void SetLine(string item_name, GH_Line item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Line)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetLine

SetLine

public void SetLine(string item_name, int item_index, GH_Line item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Line)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetLine

SetPath

public void SetPath(string item_name, int item_index, string absolutePath, string basePath)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
absolutePath (string)	Absolute path to store.
basePath (string)	Base path. This will be used to also store a relative path.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPath

SetPath

public void SetPath(string item_name, string absolutePath, string basePath)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
absolutePath (string)	Absolute path to store.
basePath (string)	Base path. This will be used to also store a relative path.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPath

SetPlane

public void SetPlane(string item_name, GH_Plane item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Plane)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetPlane

SetPlane

public void SetPlane(string item_name, int item_index, GH_Plane item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Plane)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPlane

SetPoint2D

public void SetPoint2D(string item_name, GH_Point2D item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Point2D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetPoint2D

SetPoint2D

public void SetPoint2D(string item_name, int item_index, GH_Point2D item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Point2D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPoint2D

SetPoint3D

public void SetPoint3D(string item_name, GH_Point3D item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Point3D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetPoint3D

SetPoint3D

public void SetPoint3D(string item_name, int item_index, GH_Point3D item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Point3D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPoint3D

SetPoint4D

public void SetPoint4D(string item_name, GH_Point4D item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Point4D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetPoint4D

SetPoint4D

public void SetPoint4D(string item_name, int item_index, GH_Point4D item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Point4D)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetPoint4D

SetSingle

public void SetSingle(string item_name, float item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (float)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetSingle

SetSingle

public void SetSingle(string item_name, int item_index, float item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (float)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetSingle

SetString

public void SetString(string item_name, int item_index, string item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (string)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetString

SetString

public void SetString(string item_name, string item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (string)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetString

SetVersion

public void SetVersion(string item_name, GH_Version item_value)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_value (GH_Version)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetVersion

SetVersion

public void SetVersion(string item_name, int item_index, GH_Version item_value)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
item_value (GH_Version)	Value of item to add.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetVersion

SetVersion

public void SetVersion(string item_name, int item_index, int major, int minor, int revision)

Add a new data item to this chunk. The combination of name and index must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
item_index (int)	Index of item to add.
major (int)	Major component of Version structure.
minor (int)	Minor component of Version structure.
revision (int)	Revision component of Version structure.

Exceptions:

InvalidOperationException

Thrown if another item with the same name and index already exists.

Implements: SetVersion

SetVersion

public void SetVersion(string item_name, int major, int minor, int revision)

Add a new data item to this chunk. The name must be unique or an exception will be thrown.

Parameters:

item_name (string)	Name of item to add.
major (int)	Major component of Version structure.
minor (int)	Minor component of Version structure.
revision (int)	Revision component of Version structure.

Exceptions:

InvalidOperationException

Thrown if another item with the same name already exists.

Implements: SetVersion

TryGetBoolean

public bool TryGetBoolean(string item_name, int item_index, ref bool value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref bool)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetBoolean

TryGetBoolean

public bool TryGetBoolean(string item_name, ref bool value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref bool)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetBoolean

TryGetBoundingBox

public bool TryGetBoundingBox(string item_name, int item_index, ref GH_BoundingBox value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_BoundingBox)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetBoundingBox

TryGetBoundingBox

public bool TryGetBoundingBox(string item_name, ref GH_BoundingBox value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_BoundingBox)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetBoundingBox

TryGetByte

public bool TryGetByte(string item_name, int item_index, ref byte value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref byte)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetByte

TryGetByte

public bool TryGetByte(string item_name, ref byte value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref byte)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetByte

TryGetDate

public bool TryGetDate(string item_name, int item_index, ref DateTime value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref DateTime)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDate

TryGetDate

public bool TryGetDate(string item_name, ref DateTime value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref DateTime)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDate

TryGetDecimal

public bool TryGetDecimal(string item_name, int item_index, ref decimal value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref decimal)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDecimal

TryGetDecimal

public bool TryGetDecimal(string item_name, ref decimal value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref decimal)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDecimal

TryGetDouble

public bool TryGetDouble(string item_name, int item_index, ref double value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref double)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDouble

TryGetDouble

public bool TryGetDouble(string item_name, ref double value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref double)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDouble

TryGetDrawingColor

public bool TryGetDrawingColor(string item_name, int item_index, ref Color value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Color)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingColor

TryGetDrawingColor

public bool TryGetDrawingColor(string item_name, ref Color value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Color)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingColor

TryGetDrawingPoint

public bool TryGetDrawingPoint(string item_name, int item_index, ref Point value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Point)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingPoint

TryGetDrawingPoint

public bool TryGetDrawingPoint(string item_name, ref Point value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Point)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingPoint

TryGetDrawingPointF

public bool TryGetDrawingPointF(string item_name, int item_index, ref PointF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref PointF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingPointF

TryGetDrawingPointF

public bool TryGetDrawingPointF(string item_name, ref PointF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref PointF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingPointF

TryGetDrawingRectangle

public bool TryGetDrawingRectangle(string item_name, int item_index, ref Rectangle value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Rectangle)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingRectangle

TryGetDrawingRectangle

public bool TryGetDrawingRectangle(string item_name, ref Rectangle value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Rectangle)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingRectangle

TryGetDrawingRectangleF

public bool TryGetDrawingRectangleF(string item_name, int item_index, ref RectangleF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref RectangleF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingRectangleF

TryGetDrawingRectangleF

public bool TryGetDrawingRectangleF(string item_name, ref RectangleF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref RectangleF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingRectangleF

TryGetDrawingSize

public bool TryGetDrawingSize(string item_name, int item_index, ref Size value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Size)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingSize

TryGetDrawingSize

public bool TryGetDrawingSize(string item_name, ref Size value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Size)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingSize

TryGetDrawingSizeF

public bool TryGetDrawingSizeF(string item_name, int item_index, ref SizeF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref SizeF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingSizeF

TryGetDrawingSizeF

public bool TryGetDrawingSizeF(string item_name, ref SizeF value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref SizeF)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetDrawingSizeF

TryGetGuid

public bool TryGetGuid(string item_name, int item_index, ref Guid value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref Guid)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetGuid

TryGetGuid

public bool TryGetGuid(string item_name, ref Guid value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref Guid)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetGuid

TryGetInt32

public bool TryGetInt32(string item_name, int item_index, ref int value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref int)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInt32

TryGetInt32

public bool TryGetInt32(string item_name, ref int value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref int)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInt32

TryGetInt64

public bool TryGetInt64(string item_name, int item_index, ref long value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref long)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInt64

TryGetInt64

public bool TryGetInt64(string item_name, ref long value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref long)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInt64

TryGetInterval1D

public bool TryGetInterval1D(string item_name, int item_index, ref GH_Interval1D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Interval1D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInterval1D

TryGetInterval1D

public bool TryGetInterval1D(string item_name, ref GH_Interval1D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Interval1D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInterval1D

TryGetInterval2D

public bool TryGetInterval2D(string item_name, int item_index, ref GH_Interval2D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Interval2D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInterval2D

TryGetInterval2D

public bool TryGetInterval2D(string item_name, ref GH_Interval2D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Interval2D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetInterval2D

TryGetLine

public bool TryGetLine(string item_name, int item_index, ref GH_Line value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Line)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetLine

TryGetLine

public bool TryGetLine(string item_name, ref GH_Line value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Line)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetLine

TryGetPlane

public bool TryGetPlane(string item_name, int item_index, ref GH_Plane value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Plane)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPlane

TryGetPlane

public bool TryGetPlane(string item_name, ref GH_Plane value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Plane)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPlane

TryGetPoint2D

public bool TryGetPoint2D(string item_name, int item_index, ref GH_Point2D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point2D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint2D

TryGetPoint2D

public bool TryGetPoint2D(string item_name, ref GH_Point2D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point2D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint2D

TryGetPoint3D

public bool TryGetPoint3D(string item_name, int item_index, ref GH_Point3D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point3D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint3D

TryGetPoint3D

public bool TryGetPoint3D(string item_name, ref GH_Point3D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point3D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint3D

TryGetPoint4D

public bool TryGetPoint4D(string item_name, int item_index, ref GH_Point4D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Point4D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint4D

TryGetPoint4D

public bool TryGetPoint4D(string item_name, ref GH_Point4D value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Point4D)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetPoint4D

TryGetSingle

public bool TryGetSingle(string item_name, int item_index, ref float value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref float)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetSingle

TryGetSingle

public bool TryGetSingle(string item_name, ref float value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref float)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetSingle

TryGetString

public bool TryGetString(string item_name, int item_index, ref string value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref string)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetString

TryGetString

public bool TryGetString(string item_name, ref string value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref string)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetString

TryGetVersion

public bool TryGetVersion(string item_name, int item_index, ref GH_Version value)

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

Parameters:

item_name (string)	Name of item to retrieve.
item_index (int)	Index of item to retrieve.
value (ref GH_Version)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetVersion

TryGetVersion

public bool TryGetVersion(string item_name, ref GH_Version value)

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

Parameters:

item_name (string)	Name of item to retrieve.
value (ref GH_Version)	Target of assignment.

Returns: True if the value was set.

Implements: TryGetVersion

Write

public void Write(BinaryWriter writer)

Write this chunk and all child chunks to a binary stream.

Parameters:

writer (BinaryWriter)

The Binary writer to use, cannot be null.

Exceptions:

MemberAccessException

Thrown if the name of this chunk is either null or empty.

Implements: Write

Write

public void Write(XmlWriter writer)

Serialize this chunk into an Xml stream.

Parameters:

writer (XmlWriter)

Xml writer used for serialization.

Exceptions:

MemberAccessException

Thrown if

Implements: Write