GeoEco.Metadata.ResultMetadata

class GeoEco.Metadata.ResultMetadata(name, methodMetadata, typeMetadata, description=None, arcGISDisplayName=None, arcGISParameterDependencies=None)

Bases: object

Metadata that describes the value returned by a method of a Python class.

Parameters:

  • name (str) – Name of the return value. Although Python does not give names to return values, they are needed when a method is exposed as an ArcGIS goeprocessing tool, and can be useful in other contexts. Minimum length꞉ 1.

  • methodMetadata (MethodMetadata) – The MethodMetadata for the method.

  • typeMetadata (TypeMetadata) – A TypeMetadata that describes the data type and allowed values of this return value.

  • description (str, optional) – Return value description, ideally one line of plain text (but reStructuredText is OK). Put long details in MethodMetadata.LongDescription. Minimum length꞉ 1.

  • arcGISDisplayName (str, optional) – Name of the return value as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

  • arcGISParameterDependencies (list of str, optional) – list of names of parameters that this return value is dependent on (see ArcGIS documentation), when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise).

Returns:

New ResultMetadata instance.

Return type:

ResultMetadata

Properties

property ArcGISDisplayName

(str or None) Name of the return value as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

property ArcGISParameterDependencies

(list of str or None) list of names of parameters that this return value is dependent on (see ArcGIS documentation), when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise).

property Description

(str or None) Return value description, ideally one line of plain text (but reStructuredText is OK). Put long details in MethodMetadata.LongDescription. Minimum length꞉ 1.

property Method

(MethodMetadata) MethodMetadata for the class that contains this method. Read only.

property Name

(str) Name of the return value. Although Python does not give names to return values, they are needed when a method is exposed as an ArcGIS goeprocessing tool, and can be useful in other contexts. Read only. Minimum length꞉ 1.

property Type

(TypeMetadata) A TypeMetadata that describes the data type and allowed values of this return value.

Methods