Skip to content

IoosSweSos first pass documentation

DanRamage edited this page Feb 7, 2014 · 8 revisions

Basic documentation of the IoosSweSos object

  • Class diagrams are generated from PyCharm. Haven't worked out how to hide the generic object class in the listings.

IoosSweSos

Class Diagram

constructor

Parameters
* url - THe SWE endpoint we're interested in
* version - Optional default is '1.0.0' The SWE version the endpoint.
* xml - Optional default is None - The XML response from a GetCapabilities query of the server.

filter()

## Parameters
* bbox - Bounding box, not implemented for SOS calls currently.
* start  - start date for records
* end - end date for records
* features - Unsure of use
* variables - list of observed_properties

### Return

collect()

### Parameters
* offering - Station list
* responseFormat - The desired return format for the SOS call.
* eventTime - If the start/end times are not provided in the filter(), this param
  can be passed in. Has to be properly formatted: %Y-%m-%dT%H:%M:%SZ/%Y-%m-%dT%H:%M:%SZ for a
  start/end time/date.

### Return
A list of OmObservation objects are returned.

OmObservation

Class Diagram

Paegan Objects

Station

Class Diagram

Point

Class Diagram