GmsEnum Configuration

GmsEnum Configuration Data

Data

Use

Description

GmsType

Mandatory

GMSENUM

Attributes

Optional

Object containing the attributes of the property. For details, see Table GmsEnum Attributes, below. The empty object (“Attributes”: { }) resets the attributes data.

 

GmsEnum Attributes

Data

Use

Description

Valid

Optional

Validity flag. If false, the display data is set but considered invalid.

Properties

Optional

Object containing the valid range values. For details, see Table GmsEnum Properties, below. If the object is empty (“Properties”: { }), the range values are reset, while the range is UInt32.MinValue ÷ UInt32.MaxValue.

TextGroup

Optional

Name of the text group to be used for the texts corresponding to the enumerative. If the string is empty (“TextGroup”: “”), the value is reset.

 

GmsEnum Properties

Data

Use

Description

Min

Optional

Min value.

Max

Optional

Max value.

Example

{

    "Name": "Enum_Value",

    "PvssType": { "PvssType": "UINT" },

    "VL": true,

    "AL": true,

    "Persist": true,

    "GroupId": "CONFIG",

    "Description":[{"Culture":"en-US", "Text":"Enum Value"}],

    "Display": {

        "Valid": true,

        "Icon": {

            "Library": "Global_Base_HQ_1",

            "Name": "Op_DP_Generic_None_001.png"

        }

    },

    "GmsType": {

        "GmsType": "GMSENUM",

        "Attributes": {

            "Valid": true,

            "Properties": {

                "Min": 0,

                "Max": 8

            },

            "TextGroup": "TxG_Status"

        }

    }

}

 

The following image shows the corresponding fields in the Models & Functions tab: