Learn R Programming

sos4R (version 0.2-11)

SOS: Class, and Construction and Accessor Functions for "SOS"

Description

Base class of a connection to a Sensor Observation Service.

Usage

SOS(url, method = SosDefaultConnectionMethod(), version = "1.0.0", parsers = SosParsingFunctions(), encoders = SosEncodingFunctions(), dataFieldConverters = SosDataFieldConvertingFunctions(), curlOptions = list(), curlHandle = getCurlHandle(), timeFormat = sosDefaultTimeFormat, verboseOutput = FALSE, switchCoordinates = FALSE, ...)
# accessor methods ...

Arguments

url
See the corresponding slot description.
method
See the corresponding slot description.
version
See the corresponding slot description.
parsers
See the corresponding slot description.
encoders
See the corresponding slot description.
dataFieldConverters
See the corresponding slot description.
curlOptions
See the corresponding slot description.
curlHandle
See the corresponding slot description.
timeFormat
See the corresponding slot description.
verboseOutput
See the corresponding slot description.
switchCoordinates
See the corresponding slot description.
...
Additional parameters that are passed on to the getObservation call that is done within this function.

Value

SOS-class.

Objects from the Class

Objects can be created by calls to the construction function of the form SOS(...). Object from the class can be used in calls to function for metadata retrieval of sensors (link{describeSensor-methods}) and observation data queries (link{getObservation-methods} and link{getObservationById-methods})

Slots

url:
Object of class "character": The endpoint of the service, e.g. http://myUrl.org/SOS1/sos.
method:
Object of class "character": The method, or transport protocol, see SosSupportedConnectionMethods for available ones.
version:
Object of class "character": The connected service's version, e.g. "1.0.0".
capabilities:
Object of class "OwsCapabilities" ~~
parsers:
Object of class "list" ~~
encoders:
Object of class "list" ~~
dataFieldConverters:
Object of class "list": A list of named functions to be used by the parsing methods to convert data values to the correct R type, see SosDataFieldConvertingFunctions for the default functions and how to add your own converters.
curlHandle:
Object of class "CURLHandle": The curl options to be passed on to the methods getURL and postForm from the package RCurl.
curlOptions:
Object of class "ANY": The curl handle to be passed on to the methods getURL and postForm from the package RCurl.
timeFormat:
Object of class "character": The time format to be used or decoding and encoding time character strings to and from POSIXt classes.
verboseOutput:
Object of class "logical": Trigger parameter for extensive debugging information on the console.
switchCoordinates:
Object of class "logical": Trigger switching of lat/long during parsing stage.

Methods

sosAbstract
signature(obj = "SOS"): ...
sosCapabilitiesDocumentOriginal
signature(sos = "SOS"): To retrieve the full original service metadata document.
sosCaps
signature(sos = "SOS"): ...
sosContents
signature(sos = "SOS"): ...
sosDataFieldConverters
signature(sos = "SOS"): ...
sosTime
signature(obj = "SOS"): ...
sosTime
signature(obj = "SOS"): ...
sosTitle
signature(obj = "SOS"): ...
sosOperations
signature(sos = "..."): ...
sosGetCRS
signature(obj = "character"): ...
sosGetDCP
signature(sos = "SOS", operation = "character", type = "character"): Get the distributed computing platform URL for the given operation and method type. If type is missing, the function returns all available DCPs.
sosEncoders
signature(sos = "SOS"): ...
sosFeatureIds
signature(obj = "list"): ...
sosFeaturesOfInterest
signature(obj = "list"): ...
sosGetCRS
signature(obj = "character"): Get an object of class sp:::CRS for a given OGC URN depicting a reference system, like urn:ogc:def:crs:EPSG:1000.
sosMethod
signature(sos = "SOS"): ...
sosName
signature(obj = "..."): ...
sosObservedProperties
signature(sos = "SOS"): ...
sosOffering
signature(sos = "SOS", offeringId = "character"): ...
sosOfferingIds
signature(sos = "SOS"): ...
sosOfferings
signature(sos = "SOS"): ...
sosOperation
signature(sos = "SOS", operationName = "character"): ...
sosOperationsMetadata
signature(sos = "SOS"): ...
sosParsers
signature(sos = "SOS"): ...
sosProcedures
signature(sos = "SOS"): Accessor function for the procedures of a SOS (via list in capabilities of GetObservation operation) or a SosObservationOffering.
sosResponseFormats
signature(sos = "SOS"): TBD: add missing signatures ...
sosResponseMode
signature(sos = "SOS"): ...
sosResultModels
signature(sos = "SOS"): ...
sosServiceIdentification
signature(sos = "SOS"): ...
sosServiceProvider
signature(sos = "SOS"): ...
sosSrsName
signature(sos = "SOS"): ...
sosSwitchCoordinates
signature(sos = "SOS"): ...
sosTimeFormat
signature(sos = "SOS"): ...
sosUrl
signature(sos = "SOS"): ...
sosVersion
signature(sos = "SOS"): ...
sosTime
signature(obj = "SOS"): Accessor function for the event time period from the GetObservation operations metadata.
sosFilter_Capabilities
signature(sos = "SOS"): Accessor function for the filter capabilities of a SOS object.

Details

From the introduction of the specification document: “The goal of SOS is to provide access to observations from sensors and sensor systems in a standard way that is consistent for all sensor systems including remote, in-situ, fixed and mobile sensors.”

References

Na, A., Priest, M. (Eds.), Sensor Observation Service, Open Geospatial Consortium Inc., OGC 06-009r6, Version: 1.0

The document is available for download at http://www.opengeospatial.org/standards/sos.

See Also

See also creation function SOS and the package vignette for general description of use.

Examples

Run this code
showClass("SOS")

## Not run: 
# # create a SOS connection
# mysos <- SOS(url = "http://mysos.org/sos")
# 
# # create a SOS connetion with a specific connection method and time format
# mysos <- SOS(url = "http://mysos.org/sos",
#     method = "GET", timeFormat = "
# 
# # turn on verbose output for all methods and functions
# SOS(url = "http://mysos.org/sos", verboseOutput = TRUE)
# 
# # get the meaning of an exception code
# sosExceptionCodeMeaning(ex@exceptionCode)
# 
# # create a CRS object from a URN CRS string
# sosGetCRS("urn:ogc:def:crs:EPSG:4217")
# 
# # create the URL to a GET request for GetCapabilities
# sosCapabilitiesUrl(mysos)
# ## End(Not run)



Run the code above in your browser using DataLab