AARCHMRS Schema 2.5.3

↚ Home

Parameters.Group object

The Parameters.Group is a way to namespace parameters, for example: FEAT.X, or FEAT.X.Y.

object

Properties Type Description
_meta Meta
See Meta for more information.
_type
Enum
Parameters.Group
configured_by ParameterAbstract
See definitions.configured_by in ParameterAbstract for more information.
constraints ParameterAbstract
See definitions.constraints in ParameterAbstract for more information.
description ParameterAbstract
See definitions.description in ParameterAbstract for more information.
name ParameterAbstract
See definitions.name in ParameterAbstract for more information.
title ParameterAbstract
See definitions.title in ParameterAbstract for more information.
values Parameterset
See Parameterset for more information.
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Parameters.Group", 
    "name": "FEAT", 
    "values": [
        {
            "_type": "Parameters.Boolean", 
            "name": "X"
        }
    ]
}
{
    "_type": "Parameters.Group", 
    "name": "FEAT", 
    "values": [
        {
            "_type": "Parameters.Group", 
            "name": "X", 
            "values": [
                {
                    "_type": "Parameters.Boolean", 
                    "name": "Y"
                }
            ]
        }
    ]
}

Schema http://json-schema.org/draft-04/schema#

{
  "additionalProperties": false,
  "examples": [
    {
      "_type": "Parameters.Group",
      "name": "FEAT",
      "values": [
        {
          "_type": "Parameters.Boolean",
          "name": "X"
        }
      ]
    },
    {
      "_type": "Parameters.Group",
      "name": "FEAT",
      "values": [
        {
          "_type": "Parameters.Group",
          "name": "X",
          "values": [
            {
              "_type": "Parameters.Boolean",
              "name": "Y"
            }
          ]
        }
      ]
    }
  ],
  "info": [
    "The $(Parameters.Group) is a way to namespace parameters, for example: `FEAT.X`, or `FEAT.X.Y`."
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json"
    },
    "_type": {
      "enum": [
        "Parameters.Group"
      ]
    },
    "name": {
      "$ref": "ParameterAbstract.json#/definitions/name"
    },
    "title": {
      "$ref": "ParameterAbstract.json#/definitions/title"
    },
    "description": {
      "$ref": "ParameterAbstract.json#/definitions/description"
    },
    "constraints": {
      "$ref": "ParameterAbstract.json#/definitions/constraints"
    },
    "configured_by": {
      "$ref": "ParameterAbstract.json#/definitions/configured_by"
    },
    "values": {
      "$ref": "../Parameterset.json"
    }
  },
  "required": [
    "name"
  ],
  "title": "Parameters.Group",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object"
}