OpenSensorHub Toolkit

Class: DataSource

OSH.DataReceiver. DataSource

The DataSource is the abstract class used to create different datasources.

abstractnew OSH.DataReceiver.DataSource(name, properties)

datareceiver/osh-DataReceiver-DataSource.js, line 30
Name Type Description
name string

the datasource name
properties Object

the datasource properties

Name Type Description
timeShift boolean

fix some problem with some android devices with some timestamp shift to 16 sec
syncMasterTime boolean

defines if the datasource is synchronize with the others one
bufferingTime number

defines the time during the data has to be buffered
timeOut number

defines the limit time before data has to be skipped
protocol string

defines the protocol of the datasource. @see OSH.DataConnector.DataConnector

Methods

buildUrl(properties){string}

datareceiver/osh-DataReceiver-DataSourceJSON.js, line 98

Builds the full url.

Name Type Description
properties object
Name Type Description
protocol string

the connector protocol
endpointUrl string

the endpoint url
service string

the service
offeringID string

the offeringID
observedProperty string

the observed property
startTime string

the start time (ISO format)
endTime string

the end time (ISO format)
replaySpeed number

the replay factor
responseFormat number

the response format (e.g video/mp4)
Returns:
Type Description
string the full url

buildUrl(properties){string}

datareceiver/osh-DataReceiver-DataSource.js, line 190

Builds the full url.

Name Type Description
properties object
Name Type Description
protocol string

the connector protocol
endpointUrl string

the endpoint url
service string

the service
offeringID string

the offeringID
observedProperty string

the observed property
startTime string

the start time (ISO format)
endTime string

the end time (ISO format)
replaySpeed number

the replay factor
responseFormat number

the response format (e.g video/mp4)
Returns:
Type Description
string the full url

connect()

datareceiver/osh-DataReceiver-DataSource.js, line 100

Connect the dataSource then the connector will be opened as well.

disconnect()

datareceiver/osh-DataReceiver-DataSource.js, line 84

Disconnect the dataSource then the connector will be closed as well.

getId(){string}

datareceiver/osh-DataReceiver-DataSource.js, line 160

Gets the datasource id.

Returns:
Type Description
string the datasource id

getName(){*}

datareceiver/osh-DataReceiver-DataSource.js, line 170

Gets the datasource name.

Returns:
Type Description
*

initDataSource(properties)

datareceiver/osh-DataReceiver-DataSource.js, line 47

Inits the datasource with the constructor properties.

Name Type Description
properties

onData(data)

datareceiver/osh-DataReceiver-DataSource.js, line 152
Name Type Description
data Object

the data object
Example
data is represented as
data = {
   timeStamp: timeStamp // number
   data: data // data to render
};

parseData(data){String|Object|number|ArrayBuffer|*}

datareceiver/osh-DataReceiver-DataSource.js, line 137

The default timestamp parser

Name Type Description
data

the full data message returned by the connector
Returns:
Type Description
String | Object | number | ArrayBuffer | * data the formatted data

parseTimeStamp(data){number}

datareceiver/osh-DataReceiver-DataSource.js, line 126

The default timestamp parser

Name Type Description
data

the full data message returned by the connector
Returns:
Type Description
number the formatted timestamp

Type Definitions

onMessage

The callback which receives data.