ParameterCollection Class

Description

The ParameterCollection class organizes a collection of parameters for use with various objects in GeoCalcNET.  A parameter consists of a name and a value.  The ParameterCollection class provides methods and properties that allow one to create, delete, change, and retrieve the parameters in the collection.  The types of values supported by the ParameterCollection class are outlined in the ItemType enumeration.

 

Public Enumerations

Enum

Description

ItemType

Contains elements that correspond to the types of parameters that a ParameterCollection can contain

 

Public Constructors

Constructor

Description

ParameterCollection

Creates a new instance of the ParameterCollection class

 

Public Properties

Property

Description

AngularItem

Provides access to the AngularValue items in this collection

Count

Indicates the number of parameters in this collection

FloatItem

Provides access to the floating point items in this collection

IntegerItem

Provides access to the integer items in this collection

LinearItem

Provides access to the LinearValue items in this collection

ParameterType

Indicates the type of the specified parameter

StringItem

Provides access to the string items in this collection

 

Public Methods

Method

Description

AddAngularItem

Adds an AngularValue to this collection

AddFloatItem

Adds a floating point value to this collection

AddIntegerItem

Adds an integer value to this collection

AddLinearItem

Adds a LinearValue to this collection

AddOptionalAngularItem

Adds an AngularValue to this collection as an optional parameter

AddOptionalFloadItem

Adds a floating point value to this collection as an optional parameter

AddOptionalIntegerItem

Adds an integer value to this collection as an optional parameter

AddOptionalLinearItem

Adds a LinearValue to this collection as an optional parameter

AddOptionalStringItem

Adds a string value to this collection as an optional parameter

AddStringItem

Adds a string value to this collection

Clear

Removes all parameters from this collection

Clone

Produces a deep-copy of the current instance

DeepCopy

Produces a deep-copy of a ParameterCollection

Dispose

Releases the resources used by the current instance

Exists

Indicates if the specified parameter exists in this collection

ParameterNameAtIndex

Indicates the name of the parameter located at the specified index in this collection

Remove

Removes the specified parameter from the collection

ValueEquals

Compares the value of two ParameterCollection instances