Definition - ParamDefDoc
The ParamDefinitionDoc document
is a definition document that contains the properties for a unique parameter instance.
The ParamDefinitionDoc document does not contain a reference to
the ConfigDoc document and therefore can be reused by multiple configurations and data sets.
| Field | Data Type | Required | Default | Description |
|---|---|---|---|---|
| id | String | Yes | - | Regno unique document identifier. |
| type | Fixed String | No | AliasDoc | Type of the document, resolved from fixed document types. |
| sourceId | String | Yes | - | A free form string description of the source for this parameter data. |
| groups | String[] | Yes | - | An array of free form strings used to generate a tree structure of the groups and subgroups that parameter belongs to. The root group should be the first entry of the array value. |
| name | String | Yes | - | A free form string value to name the parameter. |
| description | String | No | - | A free form string description of the parameter. |
| aliasDefDocs | AliasDefDoc[] | No | - | An array of aliases assigned to this parameter definition document. |
| format | String | No | - | A C style format used to display the parameter data value. See the section Format Strings for details and examples. |
| conversion | ConversionDefDoc | No | - | The unique conversion associated with the parameter definition. |
| signal | CANSignalDefDoc | No | - | The unique CAN specific signal information associated with the parameter definition. |
| units | String | No | - | A free form string describing the units. |
| tags | TagDoc[] | No | - | An array of key/value pair free form string values. Used to store meta data related to this parameter definition doc. |
| paramDefDocType | Fixed String | Yes | Scalar | String values representing the type of the parameter being created. Valid Options are: Scalar, Array, CAN, Static |