mirror of https://github.com/aurora-opensource/xviz.git synced 2026-01-18 14:07:46 +00:00

Timothy Wojtaszek 3a85736550

Change use of 'Frame' to 'Message' in XVIZ (#467 )

A 'Frame' is often overloaded, and in nearly all case
in XVIZ we mean an XVIZ Message.  We have created a distinction
where if we use 'Frame' it is not an individual message but the
set of data that constitutes a visual 'Frame' which could come from
multiple messages.  Therefore, 'Frame' is still used in @xviz/parse

2019-05-28 14:30:06 -07:00

1.7 KiB

Raw Permalink Blame History

XVIZ Reader

XVIZ Readers provide an interface to read XVIZ data and provide timing and message information about the source.

Example

import {XVIZJSONReader, MemorySource} from '@xviz/io';

const source = new MemorySource();
// XVIZ data added to source
const reader = new XVIZJSONReader(source);
const messageCount = reader.messageCount();
const meta = reader.readMetadata();

for (const i = 0; i < messageCount; i++) {
  const message = reader.readmessage(i);
}

Interface Methods

readMetadata()

Reads a log metadata from the source.

Returns: (Object|Buffer) - XVIZ metadata

readMessage(messageIndex)

Reads an XVIZ message from the source.

Parameters:

messageIndex (Number) - the index of this message. XVIZBuilder.getMessage().

Returns: (Object|Buffer) - XVIZ message

timeRange()

Returns:

(Object)
- startTime (Number) - Start time of the the source if known
- endTime (Number) - End time of the the source if known

messageCount()

Returns: (Number) - Number of messages available in the data

findMessage(timestamp)

Returns an object with the message indices for the first and last indices that are the boundaries for this timestamp.