ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-01-19 11:17:04 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

[API] Add proposal for removing delegation

Browse Source
This commit is contained in:
Victor Woeltjen 2015-08-20 14:34:59 -07:00
parent dfacf08e45
commit 553e226a5d
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/src/design/proposals/APIRedesign.md
View File

@ -784,3 +784,36 @@ SomeAction.prototype.perform = function (actionContext) {
* Requires refactoring of various types; may result in some
awkward APIs or extra factory interfaces.
## Remove capability delegation
The `delegation` capability has only been useful for the
`telemetry` capability, but using both together creates
some complexity to manage. In practice, these means that
telemetry views need to go through `telemetryHandler` to
get their telemetry, which in turn has an awkward API.
This could be resolved by:
* Removing `delegation` as a capability altogether.
* Reworking `telemetry` capability API to account for
the possibility of multiple telemetry-providing
domain objects. (Perhaps just stick `domainObject`
in as a field in each property of `TelemetryMetadata`?)
* Move the behavior currently found in `telemetryHandler`
into the `telemetry` capability itself (either the
generic version, or a version specific to telemetry
panels - probably want some distinct functionality
for each.)
### Benefits
* Reduces number of interfaces.
* Accounting for the possibility of multiple telemetry objects
in the `telemetry` capability API means that views using
this will be more immediately aware of this as a possibility.
### Detriments
* Increases complexity of `telemetry` capability's interface
(although this could probably be minimized.)