DavidGrant-NIWC
commented
1 year ago While exploring existing registered context parameters, I noted their 'name' are all in capitals and using underscores instead of spaces. Not sure if this is a requirement or not but something to keep in mind.
This has been an outstanding issue for some time, see #18
The requirement for each S-101 context parameter can (mostly) be traced back to S-52 PL 10.3.4.4 Independent Mariner Selections:
There are some exceptions, for instance the context parameter requirement for the selected safety depth originates within the IMO performance spec, and for some reason is not duplicated within 10.3.4.4 (also true of safety contour, shallow contour, etc.)
Within the S-52 CSP's, the value of each selector is (typically) accessed via a global variable (such as SAFETY_CONTOUR) as specified in S-52 PL 13.1.5:
As you can see, the currently registered "names" are not correct. For some reason, the variable names from 13.1.5 were registered instead of the selector names from 10.3.4.4.
- [ ] @alvarosanuy please remove or retire the existing S-101 context parameter registered values:
| To register new context parameters, each must define the following attributes: | Name | xmlID | Type | Default | Description |
|---|---|---|---|---|---|
| A human readable name for the context parameter (e.g. "Safety Depth") | A unique string used to reference the context parameter within the PC (e.g. "SafetyDepth") | "Double", "Boolean", "String", etc. | A default value for the context parameter (e.g. "30") | Describes the context parameter. Should be meaningful for the mariner. |
In this issue, we should focus on context parameters. The remainder of the independent mariner selections should be addressed via #18.
- [x] @DavidGrant-NIWC will update the PC to use the context parameters/attributes from the table below.
- [x] @alvarosanuy please register the following context parameters, after allowing time for discussion / requested changes.
Default values are from IEC 61174 Table 3. Other attributes are from S-52 10.3.4.4. Any changes from the S-52 requirements are noted.
| Name | xmlID | Type | Default | Description | Notes | |
|---|---|---|---|---|---|---|
| Radar overlay | RadarOverlay | Boolean | false | Should be enabled whenever the RADAR sweep is displayed | Required by S-98 C-17.1. Replaces the S-52 DAI "O" / "S" RADAR functionality. | |
| Safety depth | SafetyDepth | Double | 30 | Selected safety depth | Required by IMO PS 5.9 / PL 13.1.5. Undefined in PL 10.3.4.4 | |
| Safety contour | SafetyContour | Double | 30 | Selected safety contour | Required by IMO PS 5.8 / PL 13.1.5. Undefined in PL 10.3.4.4 | |
| Shallow contour | ShallowContour | Double | 2 | Selected shallow water contour | Required by PL 13.1.5 (optional) | Undefined in PL 10.3.4.4 |
| Deep contour | DeepContour | Double | 30 | Selected deep water contour | Required by PL 13.1.5 (optional) | Undefined in PL 10.3.4.4 |
| Full light lines | FullLightLines | Boolean | false | Show full length light sector lines | S-52 description has been changed. | |
| Simplified symbols | SimplifiedSymbols | Boolean | false | Point symbol style | S-52 name ("Paper chart / simplified symbols") has been simplified. | |
| Plain boundaries | PlainBoundaries | Boolean | true | Line symbol style | S-52 name ("Plain / Symbolized boundaries") has been simplified. | |
| Ignore scale minimum | IgnoreScamin | Boolean | false | Features remain visible regardless of display scale | S-52 name and description have been changed. | |
| Shallow water dangers | ShallowWaterDangers | Boolean | true | Show isolated dangers in shallow waters | S-52 description has been changed. | |
| Four shades | FourShades | Boolean | false | Show depth areas using four colours | Optional. S-52 description has been changed. Note that name is "Four shades" in 10.3.4.4, but "TWO_SHADES" in 13.1.5. | |
| National language | NationalLanguage | String | eng | 3-letter language code. Selects preferred language for chart text. | Optional. S-52 description has been changed. |
Other selectors required in S-52 PL 10.3.4.4 do not alter the portrayal output and therefore do not require context parameters. Further discussion of those remaining required selectors should be via #18.
alvarosanuy
JeffWootton
@DavidGrant-NIWC @JeffWootton - It looks I can go and register these new context parameters in the GI Registry myself. I just need your help to populate the right values, for each of them, using the template below:
While exploring existing registered context parameters, I noted their 'name' are all in capitals and using underscores instead of spaces. Not sure if this is a requirement or not but something to keep in mind.
Originally posted by @alvarosanuy in https://github.com/S-101-Portrayal-subWG/Working-Documents/issues/109#issuecomment-1411109001