ParameterCollection Class

Uses

Description

The ParameterCollection class organizes a collection of parameters for use with various objects in GeoCalc. 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 ParameterType enumeration.

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
StringItem	Provides access to the string items in this collection

Public Methods

Method	Description
AddAngularItem	Adds a required parameter to this collection, the value of which is represented by an AngularValue
AddFloatItem	Adds a required parameter to this collection, the value of which is represented by a floating point number
AddIntegerItem	Adds a required parameter to this collection, the value of which is represented by an Integer
AddLinearItem	Adds a required parameter to this collection, the value of which is represented by a LinearValue
AddOptionalAngularItem	Adds an optional parameter to this collection, the value of which is represented by an AngularValue
AddOptionalFloatItem	Adds an optional parameter to this collection, the value of which is represented by a floating point number
AddOptionalIntegerItem	Adds an optional parameter to this collection, the value of which is represented by an Integer
AddOptionalLinearItem	Adds an optional parameter to this collection, the value of which is represented by a LinearValue
AddOptionalStringItem	Adds an optional parameter to this collection, the value of which is represented by a string
AddStringItem	Adds a required parameter to this collection, the value of which is represented by a string
Clear	Removes all parameters from this collection
Clone	Produces a deep-copy of the current instance
DeepCopy	Produces a deep-copy of a ParameterCollection
Exists	Indicates if the specified parameter exists in this collection
GetItemType	Retrieves the type of the parameter with the specified name
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