GeoEco.Metadata.AddResultMetadata

GeoEco.Metadata.AddResultMetadata(method, resultName, typeMetadata, description=None, arcGISDisplayName=None, arcGISParameterDependencies=None, cls=None, module=None)

Creates a ResultMetadata for a method return value and adds it to a MethodMetadata.

Parameters:

  • method (MethodType or str) – The method itself or the name of the method. If the name is given, cls must also be given.

  • resultName (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.

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

  • description (str, optional) – The return value’s description, ideally one line of plain text (but reStructuredText is OK). Put long details in MethodMetadata.LongDescription.

  • 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).

  • 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).

  • cls (type or str, optional) – The class containing the method, either as the class itself or the unqualified name of the class (without module or package names). Only needed if method is given as a name rather than the method itself.

  • module (ModuleType or str, optional) – The module that contains the class, either as the module object itself or the fully qualified name of the module (a.k.a. dotted module name). If not provided, the caller’s module is used.

Note

Before calling this function, use AddMethodMetadata() to create the MethodMetadata and add it to its class’s ClassMetadata.