Class: Sensor

OSH.Sensor

new Sensor()

Source:

Methods

buildDataFields(field, resultStruct)

Parameters:
Name Type Description
field
resultStruct
Source:

createDataConnector(observableProp, featureOfInterest, spatialFilter, startTime, endTime, playbackSpeed) → {*}

creates a data connector based on specified parameters

Parameters:
Name Type Description
observableProp
featureOfInterest
spatialFilter
startTime
endTime
playbackSpeed
Source:
Returns:
Type
*

createDataConnectorAll(featureOfInterest, spatialFilter, startTime, endTime, playbackSpeed) → {Array}

creates a data connection for each observable property with the following params

Parameters:
Name Type Description
featureOfInterest
spatialFilter
startTime
endTime
playbackSpeed
Source:
Returns:
Type
Array

describeSensor()

describe sensor retrieves data about a sensor's observable properties and metadata

Source:

getResultTemplate(observabeProp)

get result template for single observable prop

Parameters:
Name Type Description
observabeProp
Source:

getResultTemplateAll()

get result template for all properties

Source:

hasFeatureOfInterest(foi) → {boolean}

checks if feature of interest exists for this sensor

Parameters:
Name Type Description
foi
Source:
Returns:
Type
boolean

hasObservableProperty(prop) → {boolean}

checks if observable property exists for this sensor

Parameters:
Name Type Description
prop
Source:
Returns:
Type
boolean

isValidTime(timeStr) → {boolean}

checks if the time is within range defined for this sensor

Parameters:
Name Type Description
timeStr
Source:
Returns:
Type
boolean

onDescribeSensor(data)

callback for checking when a sensor description has returned

Parameters:
Name Type Description
data
Source:

onGetResultTemplate(obsProperty, resultStruct, resultEncoding)

Parameters:
Name Type Description
obsProperty
resultStruct
resultEncoding
Source:

setFieldEncoding(fieldStruct, fieldEncoding)

Parameters:
Name Type Description
fieldStruct
fieldEncoding
Source: