ParameterCollection – Global Mapper

Inherits from

System.Object

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 ItemType enumeration.

Constructors

Constructor	Description
ParameterCollection	Creates a new instance of the ParameterCollection class

Properties

Property	Description
Count	Gets the number of identifiers in the collection.
Item	Gets the value for the specified parameter.

Methods

Method	Description
AddAngularItem	Adds an AngularValue parameter to the collection.
AddDoubleItem	Adds a new floating-point value parameter to the collection.
AddIntegerItem	Adds a new integer value parameter to the collection.
AddLinearItem	Adds a new LinearValue parameter to the collection.
AddOptionalAngularItem	Adds a new optional AngularValue parameter to the collection.
AddOptionalDoubleItem	Adds a new optional floating-point value parameter to the collection.
AddOptionalIntegerItem	Adds a new optional integer value parameter to the collection.
AddOptionalLinearItem	Adds a new optional LinearValue parameter to the collection.
AddOptionalScalarItem	Adds a new optional ScalarValue parameter to the collection.
AddOptionalStringItem	Adds a new optional string value parameter to the collection.
AddScalarItem	Adds a new ScalarValue parameter to the collection.
AddStringItem	Adds a new string value parameter to the collection.
Clear	Clears the parameter collection.
Clone	Creates a clone of this object.
DecodeParameterType	Helper method to determine the parameter type from a given string.
DisableEvents	Disables events and return the existing event handler.
EnableEvents	Re-enable Eventhandler using handler.
Equals	Value equals comparison. (Overrides Object.Equals()).
Exists	Determines whether a parameter with the specified name exists in the collection.
ExistsAndSet	Determines whether a parameter with the specified name exists AND is set.
GetAngularItem	Gets the angular parameter indicated.
GetDoubleItem	Gets the double parameter indicated.
GetIntegerItem	Gets the integer parameter indicated.
GetLinearItem	Gets the linear parameter indicated.
GetScalarItem	Gets the scalar parameter indicated.
GetStringItem	Gets the string parameter indicated.
IsItemSet	Determines whether a parameter has been set.
IsOptional	Determines whether a parameter is optional.
OnChanged	Invoke the Changed event; called whenever Formatted value changes.
ParameterNameAtIndex	Gets the parameter name at the specified index location in the collection.
ParameterType	Gets the value data type for the specified parameter.
PopulateDefaultParamUnits	Populates a parameter collection with default values and types.
Remove	Removes the parameter with the specified name from the collection.
SetAngularItem	Sets the angular parameter indicated.
SetDoubleItem	Sets the double parameter indicated.
SetIntegerItem	Sets the integer parameter indicated.
SetLinearItem	Sets the linear parameter indicated.
SetScalarItem	Sets the scalar parameter indicated.
SetStringItem	Sets the string parameter indicated.
StrictlyEquals	Comparison to see if a ParameterCollection is exactly equal to this.
Inherited Method	Description
GetType	Gets the Type of the current instance. (Inherited from Object).
ToString	Returns a string that represents the current object. (Inherited from Object).

Events

Event	Description
Changed	An event that clients can use to be notified whenever the elements of the list change.

Overloaded Operators

Operator	Description
operator=	Assigns a new value to this ParameterCollection
operator==	Compares the value of two ParameterCollections
operator!=	Compares the value of two ParameterCollections