Skip to main content

SetFeatureDescription

Updated
globalmapper.SetFeatureDescription(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, string aDesc) → GM_Error_t32

Sets the description for the given area, line, or point feature in the given layer. Pass in None for the description to reset to the original description for the feature (typically the feature classification).

Parameters:

  • aLayer (GM_LayerHandle_t32) – Layer the feature is in

  • aFeatureClassType (GM_FeatureClassType_t8) – Type of feature class (area, point, line)

  • aFeatureIndex (uint32) – Index of feature in layer

  • aDesc (str) – New description for feature (use None to reset to default)

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of SetFeatureDescription.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/vector_layer_editing_sample_data/"
# Close all layers that may be open
layers_are_open = gm.GetLoadedLayerList()
if layers_are_open:
    arr_ptr, arr_size = layers_are_open
    initial_layers = gm.GM_LayerHandle_array_frompointer(arr_ptr)
    for i in range(arr_size):
        gm.CloseLayer(initial_layers[i])

err_LoadLayerList, array_pointer, array_size_param = gm.LoadLayerList(
    os.path.join(import_dir, "area.shp"),
    gm.GM_LoadFlags_HideAllPrompts,
)

arr_ptr, arr_size = gm.GetLoadedLayerList()
layers_array = gm.GM_LayerHandle_array_frompointer(arr_ptr)
layers_list = gm.carray_to_list(layers_array, arr_size)

### START SAMPLE
err_SetFeatureDescription = gm.SetFeatureDescription(
    layers_list[0], gm.GM_FeatureClass_Area, 0, "1980s Estate"
)

### END SAMPLE

assert (
    gm.GM_Error_None == err_LoadLayerList
), f"LoadLayerList: Expected {gm.GM_Error_None}, got {err_LoadLayerList}"
assert (
    gm.GM_Error_None == err_SetFeatureDescription
), f"SetFeatureDescription: Expected {gm.GM_Error_None}, got {err_SetFeatureDescription}"

assert os.path.isdir(import_dir), f"Import directory doesn't exist: {import_dir}"

assert os.path.exists(
    os.path.join(import_dir, "area.shp")
), "Sample data doesn't exist"

Related articles