Class DataSource

SensorDataSource Through this interface data can be obtained from sensors, log files or any other means

Hierarchy

GemAutoreleaseObject
- DataSource

Accessors

availableDataTypes

get availableDataTypes(): DataType[]
The available data types.

Returns DataType[]
The available data types.
- Defined in core/sensedatasource.ts:294

dataSourceType

get dataSourceType(): DataSourceType
The data source type

Returns DataSourceType
DataSourceType.live if the data source is live or external, DataSourceType.playback if the data source is playback or simulate
- Defined in core/sensedatasource.ts:252

isSDKInstance

get isSDKInstance(): boolean
Test if this is an SDK instance

Returns boolean
True if the interface is an SDK instance, false otherwise
- Defined in core/sensedatasource.ts:434

isStopped

get isStopped(): boolean
Check if source is paused

Returns boolean
True if stopped, false if not.
- Defined in core/sensedatasource.ts:242

origin

get origin(): Origin
The origin of the data source

Returns Origin
The origin of the data source
- Defined in core/sensedatasource.ts:385

playback

get playback(): Playback | null
Get the playback interface

Returns Playback | null
The playback listener object if available, null otherwise
- Defined in core/sensedatasource.ts:395

pointerId

get pointerId(): number
Returns number
- Defined in core/sensedatasource.ts:116

Methods

addListener

addListener(
    listener: DataSourceListener,
    dataType: DataType,
    parameters?: ParameterList,
): GemError
Register a listener for the data source
Parameters
- listener: DataSourceListener
  The listener to be registered
- dataType: DataType
  The data type for which the listener will be registered
- Optionalparameters: ParameterList
  Optional list of parameters
Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:463

dispose

dispose(): void
Returns void
- Defined in core/sensedatasource.ts:507

getConfiguration

getConfiguration(type: DataType): PositionSensorConfiguration
Get the current configuration for a data type
Parameters
- type: DataType
  The data type for which the configuration will be returned
Returns PositionSensorConfiguration
The configuration as PositionSensorConfiguration
- Defined in core/sensedatasource.ts:349

getDataTypeDescription

getDataTypeDescription(type: DataType): string
The data type description
Parameters
- type: DataType
  The data type for which the description is requested.
Returns string
The description of the data type.
- Defined in core/sensedatasource.ts:279

getLatestData

getLatestData(type: DataType): SenseData | null
Get the latest produced data for a data type
Parameters
- type: DataType
  The data type for which the data is requested.
Returns SenseData | null
The latest produced data or null if not available
- Defined in core/sensedatasource.ts:310

getPreferences

getPreferences(type: DataType): SearchableParameterList
Get the preferences for a data type
Parameters
- type: DataType
  The data type for which the preferences will be returned
Returns SearchableParameterList
The configuration as SearchableParameterList
- Defined in core/sensedatasource.ts:370

isDataTypeAvailable

isDataTypeAvailable(dataType: DataType): boolean
Test if a data type is provided by the data source.
Parameters
- dataType: DataType
  The data type.
Returns boolean
True if the data type is available, false otherwise.
- Defined in core/sensedatasource.ts:263

isMockData

isMockData(type: DataType): boolean
Check if mock data is enabled for the given type
Parameters
- type: DataType
  Type of the data
Returns boolean
True if the data is mocked, false otherwise
- Defined in core/sensedatasource.ts:424

pushData

pushData(senseData: SenseData): boolean
Push the data to the data source
Parameters
- senseData: SenseData
  The data to push
Returns boolean
True if the push data type is available, false otherwise
- Defined in core/sensedatasource.ts:445

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

removeListener

removeListener(listener: DataSourceListener, dataType: DataType): GemError
Unregister a listener for the data source for a specific data type
Parameters
- listener: DataSourceListener
  The listener to be unregistered
- dataType: DataType
  The data type for which the listener will be unregistered
Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:488

removeListenerAllDataTypes

removeListenerAllDataTypes(listener: DataSourceListener): void
Unregister all listeners for the data source for all data types
Parameters
- listener: DataSourceListener
  The listener to be unregistered
Returns void
- Defined in core/sensedatasource.ts:501

setConfiguration

setConfiguration(config: PositionSensorConfiguration, type?: DataType): GemError
Update the configuration for the specified type.
Parameters
- config: PositionSensorConfiguration
  The configuration to be applied
- type: DataType = DataType.position
  The data type for which the configuration will be set (default: DataType.position)
Returns GemError
GemError.success on success
- Defined in core/sensedatasource.ts:332

setMockData

setMockData(type: DataType, senseData: SenseData): GemError
Set mock position data
Parameters
- type: DataType
  The data type to be set
- senseData: SenseData
  The data to set
Returns GemError
GemError.success on success, GemError.notSupported if not supported, other GemError values on failure
- Defined in core/sensedatasource.ts:410

start

start(): GemError
Start the source

Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:222

stop

stop(): GemError
Stop the source

Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:232

`Static`createExternalDataSource

createExternalDataSource(dataTypes: DataType[]): DataSource | null
Create a new external data source
Parameters
- dataTypes: DataType[]
  List of available data types for this data source. It is mandatory to provide DataType.position within the dataTypes list.
Returns DataSource | null
The created DataSource or null if failed
- Defined in core/sensedatasource.ts:125

`Static`createLiveDataSource

createLiveDataSource(): DataSource | null
Create a new live data source

Returns DataSource | null
The created DataSource or null if failed
- Defined in core/sensedatasource.ts:151

`Static`createLogDataSource

createLogDataSource(logPath: string): DataSource | null
Create a new log data source based on a log file
Parameters
- logPath: string
  The log file path. The log file should not be a .gm file. Other formats such as .gpx are supported.
Returns DataSource | null
The created DataSource or null if failed
- Defined in core/sensedatasource.ts:174

`Static`createSimulationDataSource

createSimulationDataSource(route: Route): DataSource | null
Create a data source based on a route (a route simulation data source).
Parameters
- route: Route
  The route used for generating data source data.
Returns DataSource | null
The created DataSource or null if failed
- Defined in core/sensedatasource.ts:197

`Static`init

init(id: number): DataSource
Parameters
- id: number
Returns DataSource
- Defined in core/sensedatasource.ts:109

Class DataSource

Hierarchy

Index

Accessors

Methods

Accessors

availableDataTypes

Returns DataType[]

dataSourceType

Returns DataSourceType

isSDKInstance

Returns boolean

isStopped

Returns boolean

origin

Returns Origin

playback

Returns Playback | null

pointerId

Returns number

Methods

addListener

Parameters

Returns GemError

dispose

Returns void

getConfiguration

Parameters

Returns PositionSensorConfiguration

getDataTypeDescription

Parameters

Returns string

getLatestData

Parameters

Returns SenseData | null

getPreferences

Parameters

Returns SearchableParameterList

isDataTypeAvailable

Parameters

Returns boolean

isMockData

Parameters

Returns boolean

pushData

Parameters

Returns boolean

ProtectedregisterAutoReleaseObject

Parameters

Returns void

removeListener

Parameters

Returns GemError

removeListenerAllDataTypes

Parameters

Returns void

setConfiguration

Parameters

Returns GemError

setMockData

Parameters

Returns GemError

start

Returns GemError

stop

Returns GemError

StaticcreateExternalDataSource

Parameters

Returns DataSource | null

StaticcreateLiveDataSource

Returns DataSource | null

StaticcreateLogDataSource

Parameters

Returns DataSource | null

StaticcreateSimulationDataSource

Parameters

Returns DataSource | null

Staticinit

Parameters

Returns DataSource

`Protected`registerAutoReleaseObject

`Static`createExternalDataSource

`Static`createLiveDataSource

`Static`createLogDataSource

`Static`createSimulationDataSource

`Static`init