Свойства параметров задачи (REST)

Каждая задача геообработки имеет хотя бы один параметр. Каждый параметр задачи имеет набор описательных свойств, которые способствуют получению лучшего представления о параметре и определению подходящих значений для успешного выполнения задачи. На приведенном ниже снимке экрана показан примерный параметр задачи Расстояние (Distance) и его отображение на странице задачи геообработки в каталоге сервисов. Ниже также описана значимость каждого свойства.

Тип данных

Тип данных параметра указывает тип значения, которое должно быть предоставлено клиентом для этого параметра. Значение параметра может быть просто строкой, значением long, double, логическим значением или датой. Или оно может являться набором объектов (коллекцией объектов с атрибутами аналогично классу объектов), таблицей или растром. Например, если тип данных является long. необходимо также предоставить числовое значение между −2147483648 и 2147483647. Любые другие десятичные ил строковые значения приведут к неожиданному поведению инструмента. Аналогично, если используется тип данных растр, необходимо предоставить соответствующие данные растра для успешной работы инструмента. В приведенном ниже списке показаны типы данных параметра задачи и ожидаемые значения.

Тип данных	Значение	Пример представления JSON
GPLong	Целочисленное значение между −2147483648 и 2147483647	345
GPDouble	Десятичные значения	1.414
GPString	Строка	TextString
GPBoolean	true или false	true
GPLinearUnit	Значение, которое является расстоянием и соответствующая единица измерения, например мили, километры, футы и т. д.	{ "distance" : 345.678, "units" : "esriMiles" }
GPDate	Число, представляющее количество миллисекунд с начала эпохи (1 января 1970 г.) в формате UTC.	1199145600000
GPDataFile	Любой тип файла, например .txt, .pdf, .csv и т. п.	{ "url" : "http://myserver/myfile" }
GPRasterDataLayer	Растровые данные, которые состоят из матрицы ячеек (или пикселов), которая организована в строки и столбцы (сетку), где каждая ячейка содержит значение, представляющее некую информацию, например, температуру.	{ "url" : "http://myserver/lake.tif", "format" : "tif" }
GPRecordSet	Таблицы, представленные строками и столбцами.	{ "fields":[{"name":"Id","type":"esriFieldTypeString","alias":"Id"}, {"name":"State_Name","type":"esriFieldTypeString","alias":"State Name"}, {"name":"State_Abbr","type":"esriFieldTypeString","alias":"State Abbr"}], "features" : [ { "attributes" : {"Id" : 43, "State_Name" : "California","State_Abbr":"CA"}, { "attributes" : {"Id" : 67, "State_Name" : "Colorado","State_Abbr":"CO"}]} TypeString","alias":"Id"},
GPFeatureRecordSetLayer	Объекты, имеющие геометрию, пространственные привязки, определения полей и объекты.	GPFeatureRecordSetLayer JSON { "geometryType" : "esriGeometryPoint", "fields":[ {"name":"Id","type":"esriFieldTypeOID","alias":"Id"}, {"name":"Name","type":"esriFieldTypeString","alias":"Name"}], "spatialReference" : {"wkid" : 4326}, "features" : [ { "geometry" : {"x" : -104.44, "y" : 34.83, "spatialReference" : {"wkid" : 4326}}, "attributes" : {"Id" : 43,"Name" : "Feature 1"}}, { "geometry" : {"x" : -100.65, "y" : 33.69, "spatialReference" : {"wkid" : 4326}}, "attributes" : {"Id" : 42,"Name" : "Feature 2"}} ] }
GPMultiValue	Массив значений параметров геообработки одного типа данных. Например, GPMultiValue:GPString, GPMultiValue:GPLinearUnit	["Parcels", "Street Lights"] [ { "distance" : 345.67, "units" : "esriMiles" }, { "distance" : 36, "units" : "esriMiles" } ]

Примечание:

• При наличии большого количества записей и объектов применительно к параметрам GPRecordSet и GPFeatureRecordSetLayer можно хранить структуру в файле и предоставлять URL в качестве входных данных. Например, { "url" : "http://myserver/myfeatures/afile.txt"}. Текстовый файл должен содержать набор объектов или набор записей в формате JSON.
• В случае использования типа данных GPMultiValue:GPFeatureRecordSetLayer наборы данных должны иметь определения полей в целях успешного выполнения.

Отображаемое имя

Отображаемое имя является значимым именем параметра.

Направление

Направление позволяет определить, является ли параметр входным или выходным.

• esriGPParameterDirectionInput : входной параметр
• esriGPParameterDirectionOutput : выходной параметр

При выполнении задачи клиент должен предоставлять значения только для входящих параметров. Если задача была успешно выполнена, выходные параметры будут созданы сервером, а клиент сможет получить доступ к значениям этих выходных параметров.

Значение по умолчанию

При публикации сервиса геообработки задачи геообработки создаются на основе успешных результатов инструментов геообработки. Поле Значение по умолчанию (Default Value) показывает значения параметров в результате, на основе которого была создана задача. Значение по умолчанию входного параметра является примером значения параметра, которое должно быть передано для успешного выполнения задачи, а значение по умолчанию выходного параметра — это пример ожидаемого выхода задачи.

• Значение по умолчанию GPFeatureRecordSet и GPRecordSet будут содержать дополнительную информацию о схеме набора объектов или записей. Схема включает GeometryType, HasZ, HasM, пространственную привязку, поля и объекты. На приведенном ниже снимке экрана приведен пример схемы типа данных GPFeatureRecordSet.

  

  Клиент должен предоставить входные наборы объектов, которые соответствуют схеме, определенной значением по умолчанию, для успешного выполнения инструмента. Свойство Объекты (Features) схемы в большинстве случаев будет пустым. Однако если задача была опубликована с использованием опции Включить объекты (Include Features), включенные объекты будут отображены в разделе значений по умолчанию.

• Параметры GPDataFile, GPRasterData и GPRasterDataLayer не имеют значений по умолчанию.

Тип параметра

Существует три типа параметров.

1. esriParameterTypeRequired — параметр, необходимый для успешного выполнения. Клиент должен предоставить значение для этого параметра при выполнении операции с ресурсом задачи.
2. esriParameterTypeOptional — параметр является необязательным для успешного выполнения.
3. esriParameterTypeDerived — значение параметра является выходным параметром, производным от других входных параметров. Поэтому клиент не должен предоставлять значения.

Категория

При наличии большого количества входных и выходных параметров они, как правило, группируются в определенные категории для упрощения их классификации автором инструмента. На приведенном ниже снимке экрана приведен пример категорий, как они выглядят в диалоговом окне инструментов ArcGIS Desktop.

Категория указывает, принадлежит ли параметр какой-либо определенной категории, как определено автором инструмента. Значение категории может использоваться при разработке виджетов для задач геообработки.

Список выбора

Некоторые параметры GPString будут иметь дополнительное свойство Список выбора. Список выбора — это предварительно определенный набор значений, составленный издателем для успешного выполнения инструмента. Чтобы инструмент успешно отработал, клиент должен выбрать одно из значений в списке опций для выбора. Задача завершится со сбоем, если клиент предоставит любое значение, отличное от значений в списке опций для выбора. На приведенном ниже изображении экрана показаны значения списка опций для выбора в сети улиц, велосипедных маршрутов или пешеходных маршрутов для параметра GPString Transportation_mode_network. Если представлены такие значения списка выбора, клиент должен выбрать одно из значений для успешной отработки задачи.

Дополнительные сведения о создании значений списка опций для выбора применительно к параметрам во время публикации задачи