ParameterCollection Class

Inherits from

GEOCALCPBW_NAMESPACE::GeoBase

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.

Public Enumerations

Enum	Description
ItemType	Contains elements that correspond to the types of parameters

Public Constructors

Constructor	Description
CreateParameterCollection	Creates a new instance of the ParameterCollection class
ParameterCollection	Creates a new instance of the ParameterCollection class

Public Methods

Method	Description
AddAngularItem	Adds an AngularValue parameter
AddFloatItem	Adds a float parameter
AddIntegerItem	Adds an integer parameter
AddLinearItem	Adds a LinearValue parameter
AddScalarItem	Adds a ScalarValue parameter
AddStringItem	Adds a string parameter
Clear	Removes all parameters from this ParameterCollection
DeepCopy	Produces a deep-copy of a ParameterCollection
Exists	Indicates whether there exists a parameter with the specified name
get_AngularItem	Returns the value of an AngularValue parameter
get_Count	Returns the number of parameters in this ParameterCollection
get_FloatItem	Returns the value of a float parameter
get_IntegerItem	Returns the value of an integer parameter
get_LinearItem	Returns the value of a LinearValue parameter
get_ParameterType	Indicates the type of the specified parameter, according to the ItemType enumeration
get_ScalarItem	Returns the value of a ScalarValue parameter
get_StringItem	Returns the value of a string parameter
ParameterNameAtIndex	Indicates the name of the parameter at the specified index
Remove	Removes the specified parameter from this ParameterCollection
set_AngularItem	Sets the value of an AngularValue parameter
set_FloatItem	Sets the value of a float parameter
set_IntegerItem	Sets the value of an integer parameter
set_LinearItem	Sets the value of a LinearValue parameter
set_ScalarItem	Sets the value of a ScalarValue parameter
set_StringItem	Sets the value of a string parameter
ValueEquals	Compares the value of two ParameterCollections

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