Class SpheroDataFrame

Hierarchy

  • DataFrame
    • SpheroDataFrame

Constructors

constructor

Properties

createdTimestamp phenomenonTimestamp? uid x y

Accessors

source

Methods

addObject addReferenceSpace addSensor clone getObjectByUID getObjects getSensor hasObject removeObject

Constructors

constructor

Properties

createdTimestamp

createdTimestamp: number

Data frame created timestamp (ISO 8601)

Optional phenomenonTimestamp

phenomenonTimestamp?: number

Data frame sensor data pheonomenon timestamp (ISO 8601)

uid

uid: string

Data frame unique identifier

x

x: number

y

y: number

Accessors

source

  • get source(): DataObject

  • Source object clone that captured the data frame

    Returns

    Source data object

    Returns DataObject

  • set source(object: DataObject): void

  • Set the source object clone that captured the data frame

    Parameters

    • object: DataObject

      Source data object

    Returns void

Methods

addObject

  • Add a new object relevant to this data frame

    Returns

    instance

    Parameters

    • object: DataObject

      Relevant object

    Returns SpheroDataFrame

addReferenceSpace

  • Add a new reference space relevant to this data frame.

    Alias

    addObject Alias for addObject

    Parameters

    • referenceSpace: ReferenceSpace

      Relevant reference space

    Returns void

addSensor

  • Add a new sensor relevant to this data frame

    Returns

    instance

    Parameters

    • object: SensorObject<Object | SensorValue<Unit> | Orientation>

      Relevant sensor

    Returns SpheroDataFrame

clone

  • Clone the data frame

    Returns

    Cloned data frame

    Returns SpheroDataFrame

getObjectByUID

  • Get a specific object by its identifier

    Returns

    Data object if found

    Type Parameters

    • T extends DataObject<T>

    Parameters

    • uid: string

      Object UID

    Returns T

getObjects

  • Get known objects used in this data frame

    Returns

    Array of found data objects

    Type Parameters

    • T extends DataObject<T>

    Parameters

    • Optional dataType: (new () => T)

      Data object type

        • new (): T

        • Returns T

    Returns T[]

getSensor

  • Get known sensor objects used in this data frame

    Returns

    Found data objects

    Type Parameters

    • T extends SensorObject<Object | SensorValue<Unit> | Orientation, T>

    Parameters

    • type: (new (uid?: string) => T)

      Sensor type

        • new (uid?: string): T

        • Parameters

          • Optional uid: string

          Returns T

    • Optional defaultUID: string

      Default UID. When sensor is not added, it will be created

    Returns T

hasObject

  • Check if the data frame has an object

    Returns

    Object exist

    Parameters

    • object: DataObject

      Data object to find

    Returns boolean

removeObject

  • Remove an object from the data frame

    Parameters

    • object: DataObject

      Object to remove

    Returns void

Settings

Member Visibility

Theme