AerisWeather Python SDK  0.3.2
All Classes Namespaces Files Functions Variables Pages
aerisweather.responses.ObservationsResponse.ObservationsResponse Class Reference

Defines an object for the Observation data returned in an Aeris API observation responses. More...

Inheritance diagram for aerisweather.responses.ObservationsResponse.ObservationsResponse:
aerisweather.responses.Response.Response

Public Member Functions

def __init__ (self, json_data=None)
 Constructor Takes a single response json object from an Aeris API data response. More...
 
def id (self)
 Returns the id value of the observation station. More...
 
def place (self)
 Returns an AerisPlace object. More...
 
def profile (self)
 Returns an AerisProfile object. More...
 
def relativeTo (self)
 Returns an AerisRelativeTo object. More...
 
def raw (self)
 Returns a json object containing the raw response data. More...
 
def ob (self)
 Returns an observation json object. More...
 
def obTimestamp (self)
 Returns an int (int handles long ints in Python v3) containing the timestamp of the observation. More...
 
def obDateTime (self)
 Returns a formatted string containing the timestamp of the observation. More...
 
- Public Member Functions inherited from aerisweather.responses.Response.Response
def __init__ (self, json_data=None)
 Constructo. More...
 
def loc (self)
 Returns a location json object. More...
 

Public Attributes

 data
 
- Public Attributes inherited from aerisweather.responses.Response.Response
 data
 
 error
 

Static Public Attributes

dictionary data = {}
 
- Static Public Attributes inherited from aerisweather.responses.Response.Response
dictionary data = {}
 

Detailed Description

Defines an object for the Observation data returned in an Aeris API observation responses.

Constructor & Destructor Documentation

◆ __init__()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.__init__ (   self,
  json_data = None 
)

Constructor Takes a single response json object from an Aeris API data response.

Examples would be: either of the responses in the following response array: "response": [ { ... }, { ... } or the contents of a single response: "response": { "loc": { "lat": 43.80136,

Member Function Documentation

◆ id()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.id (   self,
  str 
)

Returns the id value of the observation station.

◆ ob()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.ob (   self,
  ObservationsData 
)

Returns an observation json object.

◆ obDateTime()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.obDateTime (   self)

Returns a formatted string containing the timestamp of the observation.

◆ obTimestamp()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.obTimestamp (   self,
  int 
)

Returns an int (int handles long ints in Python v3) containing the timestamp of the observation.

◆ place()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.place (   self)

Returns an AerisPlace object.

◆ profile()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.profile (   self)

Returns an AerisProfile object.

◆ raw()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.raw (   self)

Returns a json object containing the raw response data.

◆ relativeTo()

def aerisweather.responses.ObservationsResponse.ObservationsResponse.relativeTo (   self,
  AerisRelativeTo 
)

Returns an AerisRelativeTo object.

Member Data Documentation

◆ data [1/2]

dictionary aerisweather.responses.ObservationsResponse.ObservationsResponse.data = {}
static

◆ data [2/2]

aerisweather.responses.ObservationsResponse.ObservationsResponse.data

The documentation for this class was generated from the following file: