mirror of https://github.com/nasa/openmct.git synced 2024-12-19 13:17:53 +00:00

History

Pete Richards 49560698f6 [Reorg] Make timeline-specific chart directive Make a separate chart directive for drawing resource graphs in timelines. This is in preparation for a new plot bundle which will make a large number of changes to the drawing API to support newly requested features. By separating code, there will be no impact to the timeline when the new plot features are added.		2017-01-17 09:59:00 -08:00
..
res	[Reorg] Make timeline-specific chart directive	2017-01-17 09:59:00 -08:00
src	[Reorg] Make timeline-specific chart directive	2017-01-17 09:59:00 -08:00
test	[Reorg] Make timeline-specific chart directive	2017-01-17 09:59:00 -08:00
bundle.js	[Reorg] Make timeline-specific chart directive	2017-01-17 09:59:00 -08:00
README.md	[Timeline] Remove namespacing from README	2015-10-23 13:45:54 -07:00

README.md

This bundle provides the Timeline domain object type, as well as other associated domain object types and relevant views.

Implementation notes

Model Properties

The properties below record properties relevant to using and understanding timelines based on their JSON representation. Additional common properties, such as modified or persisted timestamps, may also be present.

Timeline Model

A timeline's model looks like:

{
    "type": "timeline",
    "start": {
        "timestamp": <number> (milliseconds since epoch),
        "epoch": <string> (currently, always "SET")
    },
    "capacity": <number> (optional; battery capacity in watt-hours)
    "composition": <string[]> (array of identifiers for contained objects)
}

The identifiers in a timeline's composition field should refer to other Timeline objects, or to Activity objects.

Activity Model

An activity's model looks like:

{
    "type": "activity",
    "start": {
        "timestamp": <number> (milliseconds since epoch),
        "epoch": <string> (currently, always "SET")
    },
    "duration": {
        "timestamp": <number> (duration of this activity, in milliseconds)
        "epoch": "SET" (this is ignored)
    },
    "relationships": {
        "modes": <string[]> (array of applicable Activity Mode ids)
    },
    "link": <string> (optional; URL linking to associated external resource)
    "composition": <string[]> (array of identifiers for contained objects)
}

The identifiers in a timeline's composition field should only refer to other Activity objects.

Activity Mode Model

An activity mode's model looks like:

{
    "type": "mode",
    "resources": {
        "comms": <number> (communications utilization, in Kbps)
        "power": <number> (power utilization, in watts)
    }
}