| |||
| Home > Supplementary Display Module Formats > User-defined formats > SDM format reference | |||
Typedefs are constructed using the TYPEDEF type,
described in Table C.8.
Table C.8. Typedef type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
TYPEDEF RDIName (NAME, CLASS) | - | - | RDIName = a unique name
to define the type. |
NAME = “context name”. | |||
CLASS = “context group”. |
Fields are constructed using the FIELD type,
described in Table C.9.
Table C.9. Field type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
FIELD [hi:lo] {,[hi:lo] {...}}
(NAME, TYPE, ACCESS) | - | - | NAME = “text name”, for
dialog and tooltip. |
TYPE = any predefined TYPEDEF
or TYPEDEF already seen in current SDM text. | |||
ACCESS = “access modifier” (default
= “RW”). |
The fundamental types are described in Table C.10.
Table C.10. Fundamental types, with parameters and classifications
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
NUMERIC (WIDTH, MIN,
MAX, DEFAULT, PREFIX, PREPAD, PRINTF, TOOLTIP) | Numeric | General | WIDTH is in bits (in any
type where it is used). Required. |
DEFAULT = “HEX”, “DEC”, “UDEC”,
“OCT”, or “BIN” (default = “HEX”). | |||
PREFIX = “Y” or “N” (default dependent
on DEFAULT). | |||
PREPAD = “Y” or “N” (default dependent
on DEFAULT). | |||
PRINTF = any valid printf
string for a numeric, for example “0x%08X” (default dependent on DEFAULT).
If used, PREFIX and PREPAD are
ignored. | |||
TOOLTIP = “A useful hint
to the user”. | |||
FLAG (SET, UNSET, TOOLTIP) | - | - | Implied WIDTH = 1, always. |
SET and UNSET are
usually single character strings. | |||
TOOLTIP = “A useful hint
to the user”. | |||
ENUM (WIDTH, DEFAULT, TOOLTIP) | - | - | WIDTH = number of bits this
enum represents. |
DEFAULT = “String to show
when value not included in enumeration (not Selectable)”. | |||
TOOLTIP = “A useful hint
to the user”. | |||
CHARACTER (WIDTH, PRINTF, TOOLTIP) | Character | General | Represents a WIDTH in bits, accepted
values 7,8, N*8. Represents byte host-endian array of individual
characters (not a nul-terminated string). |
PRINTF = any valid printf
string for a character, for example “\”% 4s\”” (default dependent on WIDTH). | |||
TOOLTIP = “A useful hint
to the user”. | |||
IEEE_FLOAT (WIDTH, PRINTF,
TOOLTIP) | IEEE Float | Floating point | WIDTH = 32 or 64, for now. |
PRINTF = any valid printf
string for a float, for example “%f” (default dependent on WIDTH). | |||
TOOLTIP = “A useful hint
to the user”. | |||
FPA_SINGLE (PRINTF, TOOLTIP) | FPA Single | Floating point | WIDTH = 32, always. |
PRINTF = any valid printf
string for a float, for example “%f” (default dependent on WIDTH). | |||
TOOLTIP = “A useful hint
to the user”. | |||
FPA_DOUBLE (PRINTF, TOOLTIP) | FPA Double | Floating point | WIDTH = 64, always. |
PRINTF = any valid printf
string for a float, for example “%f” (default dependent on WIDTH). | |||
TOOLTIP = “A useful hint
to the user”. | |||
FPA_EXTENDED (PRINTF, TOOLTIP) | FPA Extended | Floating point | WIDTH = 80, always. |
PRINTF = any valid printf
string for a float, for example “%f” (default dependent on WIDTH). | |||
TOOLTIP = “A useful hint
to the user”. | |||
FPA_INTERNAL (PRINTF, TOOLTIP) | FP Internal | Floating point | To be confirmed. |
QFORMAT (N, M, PRINTF, TOOLTIP,
DEFAULT) | Q-format | DSP | N = numeric. |
M = numeric. | |||
PRINTF = any valid printf
string for a float, for example “%f” (default dependent on WIDTH). | |||
DEFAULT = “UNSIGNED” (only for
unsigned Q-format). | |||
TOOLTIP = “A useful hint
to the user”. |
Composite types are constructed using the composite type, described in Table C.11.
Table C.11. Composite type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
COMPOSITE (WIDTH) | - | - | WIDTH = number of bits expected in
data. |
Group types are constructed using the group type, described in Table C.12 and only visible in a dialog.
Table C.12. Group type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
GROUP (NAME) | - | - | NAME = “Group box name”. |
Reserved types are constructed using the Reserved type, described in Table C.13.
Table C.13. Reserved type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
RESERVED (WIDTH, NAME, GUINAME,
TEXTNAME) | - | - | WIDTH = number of bits expected in
data. |
NAME = “Text to appear”. | |||
GUINAME = “Text to appear
in GUI”. Overrides NAME. | |||
TEXTNAME = “Text to appear
in monitor”. Overrides NAME. |
Separators contain no data and are constructed using the Separator type, described in Table C.14.
Table C.14. Separator type
| Type (param, param, ...) | Name | Classification | Notes |
|---|---|---|---|
SEPARATOR (NAME, GUINAME, TEXTNAME) | - | - | NAME = “Text to appear”. |
If NAME = “NEWLINE” the dialog
box forces a new line of controls from this point. | |||
GUINAME = “Text to appear
in GUI”. Overrides NAME. | |||
TEXTNAME = “Text to appear
in monitor”. Overrides NAME. |