Die Eigenschaft
ParameterInfo ist von zentraler Bedeutung. Sie beschreibt nämlich die einzelnen Input- und Output-Parameter des GP-Tools. Genauer gesagt enthält die Eigenschaft einen Array von
IGPParameter-Objekten. Mit IGPParameter können alle möglichen Parameter von Feature Classes über Zahlen bis zu Mehrfach-Auswahllisten definiert werden.
Der Typ des Parameters wird hauptsächlich durch die Eigenschaft
DataType definiert. Eine Liste aller möglichen Parametertypen ist
hier zu finden. Eine Besonderheit gilt es anzumerken: Soll der Parameter eine FeatureClass sein, hat man zwei Möglichkeiten: DEFeatureClassType oder GPFeatureLayerType. DEFeatureClassType meint immer die Feature Class so wie sie in der DB oder als Shapefile vorliegt. Mit GPFeatureLayerType ist zwar dieselbe Feature Class gemeint aber zusätzlich auch in Form eines FeatureLayers (in ArcMap). Es ist meistens sinnvoll, den DataType auf GPFeatureLayerType zu setzen, da damit auch eventuelle Definition Queries und Selections, die auf die Feature Class angewendet werden, berücksichtigt werden können. Bei DEFeatureClassType ist dies nicht möglich.
Zusätzlich kann der Parameter mit den Eigenschaften
Name und
DisplayName so beschrieben werden, dass der Benutzer begreift, was er hier eingeben muss.
Sehr wichtig ist daneben auch noch die Eigenschaft
ParameterDependencies. Damit können Beziehungen/Abhängigkeiten zwischen verschiedene Parametern hergestellt werden. Wenn z.B. Parameter1 eine Feature Class ist und Parameter2 ein Feld (Attribut), dann wird durch die Abängigkeit dem Benutzer in der Geoprocessing-GUI für den Parameter2 automatisch eine Liste der Felder der Feature Class aus Parameter1 angezeigt, aus der er auswählen kann.
Ähnlich wichtig ist die Eigenschaft
Domain. Damit kann der Parameter innerhalb des oben angegebenen DataTypes weiter eingegrenzt werden. Ist der DataType eine beliebige FeatureClass kann mit der Domain-Eigenschaft bestimmt werden, dass nur Feature Classes vom Typ Polygon akzeptiert werden. Oder: Ist der DataType eine Zahl, kann mit der Domain-Eigenschaft der gültige Wertebereich angegeben werden. Die Domain-Eigenschaft ist sehr wichtig und hilfreich, um falsche Benutzereingaben zu vermeiden.
Mit der Eigenschaft
Value kann dem Parameter ein Default-Wert zugewiesen werden.
Da es sowohl Input- als auch Output-Parameter gibt, muss dies in der Parameter-Definition ebenfalls spezifiziert werden. Dies geschieht mit der
Direction-Eigenschaft. Ein Input-Parameter ist ein Parameter, den das Tool als Ausgangswert benötigt. Ein Output-Parameter hingegen ist im Prinzip das Resultat des Tools. Entsteht als Ergebnis des Tools z.B. eine neue Feature Class, muss diese neue Feature Class als Output-Parameter definiert werden. Dies ist übrigens auch der Fall, wenn das Tool gar keine neue Feature Class erzeugt, sondern eine bestehende nur verändert (d.h. ein Feld hinzufügt). In diesem speziellen Fall wird der Parameter in der Eigenschaft Direction als Output-Parameter definiert und in der Eigenschaft
ParameterType als Derived-Parameter. Dies ist notwendig, damit das Tool auch im Model Builder reibungslos funktioniert. Fügt ein Tool einer Feature Class ein Feld zu, dann muss dieses neue Feld im Model Builder angezeigt werden. Schliesslich ist es ja möglich, dass genau dieses Feld als Input-Parameter in einem weiteren Tool benötigt wird. Nur wenn dieses neue Feld als Derived markiert ist, taucht es im Model Builder auf. Auf den Gebrauch des Tools in der Toolbox oder in der Kommandozeile hat die Derived-Markierung keinen Einfluss.
Über die
ParameterType-Eigenschaft wird ausserdem gesteuert, ob der Parameter optional oder obligatorisch ist.
Beispiel für einen Parameter, der eine Feature Class vom Typ SimpleJunction sein soll:
IGPParameterEdit gpParameter0 = new GPParameterClass();
gpParameter0.DataType = new GPFeatureLayerTypeClass();
IGPValue gpValue0 = new GPFeatureLayerClass();
gpParameter0.Value = gpValue0;
gpParameter0.Direction = esriGPParameterDirection.esriGPParameterDirectionInput;
gpParameter0.DisplayName = "Input-Layer";
gpParameter0.Enabled = true;
gpParameter0.Name = "inputLayer";
IGPFeatureClassDomain gpDomain0 = new GPFeatureClassDomainClass();
gpDomain0.AddFeatureType(esriFeatureType.esriFTSimpleJunction);
gpParameter0.Domain = (IGPDomain) gpDomain0;
gpParameter0.ParameterType = esriGPParameterType.esriGPParameterTypeRequired;
Beispiel für einen Parameter vom Typ Feld. Das Feld soll einerseits ein Feld der oben ausgewählten Feature Class sein und andererseits vom Typ Double sein:
IGPParameterEdit gpParameter1 = new GPParameterClass();
gpParameter1.DataType = new FieldTypeClass();
IGPValue gpValue1 = new FieldClass();
gpParameter1.Value = gpValue1;
gpParameter1.Direction = esriGPParameterDirection.esriGPParameterDirectionInput;
gpParameter1.DisplayName = "Feld";
gpParameter1.Enabled = true;
gpParameter1.Name = "inputLayerFeld";
gpParameter1.AddDependency("inputLayer");
IGPFieldDomain gpDomain1 = new GPFieldDomainClass();
gpDomain1.AddType(esriFieldType.esriFieldTypeDouble);
gpParameter1.Domain = (IGPDomain) gpDomain1;
gpParameter1.ParameterType = esriGPParameterType.esriGPParameterTypeRequired;
Übersicht:
Teil 1 (Einführung)
Teil 2 (Implementierung von IGPFunctionFactory)
Teil 3 (Implementierung von IGPFunction)
Teil 4 (Implementierung von IGPFunction:ParameterInfo)
Teil 5 (Implementierung von IGPFunction:Validate)
Teil 6 (Implementierung von IGPFunction:Execute)
Teil 7 (Fazit)
