Class: Sensor

OSH. Sensor

new OSH.Sensor()

Methods

buildDataFields(field, resultStruct)

Name Type Description
field
resultStruct

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

creates a data connector based on specified parameters

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

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

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

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

describeSensor()

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

getResultTemplate(observabeProp)

get result template for single observable prop

Name Type Description
observabeProp

getResultTemplateAll()

get result template for all properties

hasFeatureOfInterest(foi){boolean}

checks if feature of interest exists for this sensor

Name Type Description
foi
Returns:
Type Description
boolean

hasObservableProperty(prop){boolean}

checks if observable property exists for this sensor

Name Type Description
prop
Returns:
Type Description
boolean

isValidTime(timeStr){boolean}

checks if the time is within range defined for this sensor

Name Type Description
timeStr
Returns:
Type Description
boolean

onDescribeSensor(data)

callback for checking when a sensor description has returned

Name Type Description
data

onGetResultTemplate(obsProperty, resultStruct, resultEncoding)

Name Type Description
obsProperty
resultStruct
resultEncoding

setFieldEncoding(fieldStruct, fieldEncoding)

Name Type Description
fieldStruct
fieldEncoding