各ジオプロセシング タスクには 1 つ以上のパラメーターがあります。各タスク パラメーターには、説明的な名前のプロパティが用意されています。これらのプロパティは、パラメーターの理解に役立つとともに、タスク実行の成功のために適切な値を提供します。次のスクリーン キャプチャは、Services Directory のジオプロセシング タスク ページに表示されるタスク パラメーター Distance の例です。各プロパティの意味について次に説明します。
データ タイプ
パラメーターのデータ タイプは、クライアントがパラメーターに対して提供する必要がある値のタイプを示します。パラメーターの値は、string、long、double、Boolean、date のように単純なタイプであるか、フィーチャセット (フィーチャクラスと同様に、属性を持つフィーチャのコレクション)、テーブル、またはラスターのいずれかになります。たとえば、データ タイプが、-2,147,483,648 ～ 2,147,483,647 の範囲内の数値を指定する必要がある long である場合に、他の 10 進値や文字列値を指定すると、ツールの予期しない動作が発生します。同様に、ラスター データ タイプの場合にツールを正常に実行するには、適切なラスター データを指定する必要があります。次のリストに、タスク パラメーターのデータ タイプとその期待値を示します。
| データ タイプ | 値 | JSON 表現の例 |
GPLong | -2,147,483,648 ～ 2,147,483,647 の範囲内の整数値 | 345 |
GPDouble | 10 進値 | 1.414 |
GPString | 文字列 | TestString |
GPBoolean | true または false | true |
GPLinearUnit | 距離値とその計測単位 (マイル、キロメートル、フィートなど) を持つ値 | { "distance" : 345.678, "units" : "esriMiles" } |
GPDate | 紀元 (1970 年 1 月 1 日 (UTC)) からの経過秒数を表す数字 | 1199145600000 |
GPDataFile | *.txt、*.pdf、*.csv などの任意のファイル タイプ | { "url" : "http://myserver/myfile" } |
GPRasterDataLayer | 行と列 (グリッド) に整理されたセル (ピクセル) のマトリックスで構成されるラスター データ。この場合、各セルには情報を表す値が含まれます。 | { "url" : "http://myserver/lake.tif", "format" : "tif" } |
GPRecordSet | 行と列で表現されるテーブル |
|
GPFeatureRecordSetLayer | ジオメトリ、空間参照、フィールド定義、およびフィーチャを保持するフィーチャ | GPFeatureRecordSetLayer JSON |
GPMultiValue | 同じデータ タイプの GP パラメーター値の配列 例: GPMultiValue:GPString、GPMultiValue:GPLinearUnit |
["Parcels", "Street Lights"] [ { "distance" : 345.67, "units" : "esriMiles" }, { "distance" : 36, "units" : "esriMiles" } ] |
備考:
- GPRecordSet と GPFeatureRecordSetLayer のパラメーターについては、多数のレコードやフィーチャが存在する場合に、ファイルに JSON 構造を格納して、入力として URL を提供できます ({ "url" : "http://myserver/myfeatures/afile.txt"} など)。. このテキスト ファイルには、フィーチャセットとレコードセットが JSON フォーマットで含まれている必要があります。
- GPMultiValue:GPFeatureRecordSetLayer データ タイプの場合は、実行が成功するためにフィーチャセットにフィールド定義が含まれている必要があります。
表示名
表示名はパラメーターのわかりやすい名前です。
方向
方向は、パラメーターが入力または出力パラメーターのどちらに該当するかを識別するのに役立ちます。
- esriGPParameterDirectionInput : 入力パラメーター
- esriGPParameterDirectionOutput : 出力パラメーター
タスクを実行する際、クライアントは入力パラメーターの値のみを提供する必要があります。タスクが正常に実行されると、サーバーによって出力パラメーターが作成され、クライアントはこれらの出力パラメーターの値にアクセスできます。
デフォルト値
ジオプロセシング サービスの公開時に、成功したジオプロセシング ツール結果からジオプロセシング タスクが作成されます。デフォルト値には、タスクの作成元になった結果に含まれるパラメーターの値が表示されます。入力パラメーターのデフォルト値は、タスクの実行が成功するために渡される必要があるパラメーター値の例であり、出力パラメーターのデフォルト値は、タスクからの期待される出力の例です。
- GPFeatureRecordSet と GPRecordSet のデフォルト値には、フィーチャセット/レコードセットのスキーマに関する追加情報が示されます。スキーマには、ジオメトリ タイプ、HasZ、HasM、空間参照、フィールド、およびフィーチャが含まれます。次のスクリーン キャプチャは、GPFeatureRecordSet データ タイプのスキーマの例です。
ツールの実行に成功するには、クライアントは、デフォルト値によって定義されたスキーマに準拠する入力フィーチャセットを提供する必要があります。スキーマのフィーチャ プロパティは、ほとんどの場合でなしになります。ただし、タスクが、[フィーチャを含める] オプションを使用して公開されている場合は、含まれるフィーチャが、デフォルト値にリスト表示されます。
- GPDataFile、GPRasterData、および GPRasterDataLayer のパラメーターにはデフォルト値はありません。
パラメーター タイプ
パラメーター タイプには、次の 3 種類があります。
- esriParameterTypeRequired:パラメーターは、実行が成功するために必須です。クライアントは、タスクのリソースに対して操作を実行するときにパラメーターの値を提供する必要があります。
- esriParameterTypeOptional:パラメーターは、実行が成功するために必須ではありません。
- esriParameterTypeDerived:パラメーター値は、他の入力パラメーターから取得される出力パラメーターであるため、クライアントは値を提供する必要はありません。
カテゴリ
入力および出力パラメーターが多数存在する場合、通常、それらのパラメーターは、ツール作成者が理解しやすいように特定のカテゴリにグループ化されます。次のスクリーン キャプチャは、ArcGIS Desktop のツール ダイアログ ボックスで表示されるカテゴリの例です。
カテゴリは、ツール作成者の設計に従って、パラメーターが特定のカテゴリに属するかどうかを規定します。カテゴリの値は、ジオプロセシング タスク用のウィジェットを設計するときに使用できます。
選択リスト
一部の GPString パラメーターには、追加の選択リスト プロパティが示されます。選択リストは、ツールの実行が成功するために公開者によって指定される定義済みの値のセットです。実行が成功するには、クライアントが、選択リストから値の 1 つを選択する必要があります。クライアントが選択リストの値以外の値を提供した場合は、タスクが失敗します。次のスクリーン キャプチャは、GPString パラメーター Transportation_mode_network 用の選択リストの値 Street network、Bike network、Walk network を示しています。このような選択リストの値が表示された場合、クライアントは、実行の成功のためにそれらの値の中から 1 つを選択しなければなりません。
