FioDataPoint (Forecast.io client library 1.0.0 API)

java.lang.Object
- ch.rasc.forcastio.model.FioDataPoint

Direct Known Subclasses:

ImmutableFioDataPoint
```
@Value.Immutable
public abstract class FioDataPoint
extends Object
```
A data point object contains various properties, each representing a particular weather phenomenon occurring at a specific point in time. All of these properties are optional, and will only be set if we have that type of information for that location and time.
minutely data points are always aligned to the top of the minute, hourly points to the top of the hour, and daily points to midnight of the day, all according to the local time zone.
Data points in the daily data block are special: instead of representing the weather phenomena at a given instant of time, they are an aggregate point representing (unless otherwise noted) the average weather conditions that will occur over the entire day.
All of the numeric, non-time fields may, optionally, have an associated Error value defined (with the property precipIntensityError, windSpeedError, pressureError, etc.), representing our system's confidence in its prediction. Such properties represent standard deviations of the value of their associated property; small error values therefore represent a strong confidence, while large error values represent a weak confidence. These properties are omitted where the confidence is not precisely known.

Constructor Summary

Constructors
Constructor and Description

FioDataPoint()

Constructors
Constructor and Description
`FioDataPoint()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract BigDecimal`	`apparentTemperature()` A numerical value representing the apparent (or "feels like") temperature at the given time in degrees Fahrenheit.
`abstract BigDecimal`	`apparentTemperatureMax()` A numerical value representing the maximumum apparent temperature on the given day in degrees Fahrenheit.
`abstract Long`	`apparentTemperatureMaxTime()` The UNIX time at which `apparentTemperatureMax()` occurs.
`abstract BigDecimal`	`apparentTemperatureMin()` A numerical value representing the minimum apparent temperature on the given day in degrees Fahrenheit.
`abstract Long`	`apparentTemperatureMinTime()` The UNIX time at which `apparentTemperatureMin()` occurs.
`abstract BigDecimal`	`cloudCover()` A numerical value between 0 and 1 (inclusive) representing the percentage of sky occluded by clouds.
`abstract BigDecimal`	`dewPoint()` A numerical value representing the dew point at the given time in degrees Fahrenheit.
`Map<String,Object>`	`getAdditionalProperties()`
`Object`	`getAdditionalProperty(String key)`
`abstract BigDecimal`	`humidity()` A numerical value between 0 and 1 (inclusive) representing the relative humidity.
`abstract FioIcon`	`icon()` A machine-readable text summary of this data point, suitable for selecting an icon for display.
`abstract BigDecimal`	`moonPhase()` A number representing the fractional part of the lunation number of the given day: a value of 0 corresponds to a new moon, 0.25 to a first quarter moon, 0.5 to a full moon, and 0.75 to a last quarter moon.
`abstract BigDecimal`	`nearestStormBearing()` A numerical value representing the direction of the nearest storm in degrees, with true north at 0° and progressing clockwise.
`abstract BigDecimal`	`nearestStormDistance()` A numerical value representing the distance to the nearest storm in miles.
`abstract BigDecimal`	`ozone()` A numerical value representing the columnar density of total atmospheric ozone at the given time in Dobson units.
`abstract BigDecimal`	`precipAccumulation()` The amount of snowfall accumulation expected to occur on the given day, in inches.
`abstract BigDecimal`	`precipIntensity()` A numerical value representing the average expected intensity (in inches of liquid water per hour) of precipitation occurring at the given time conditional on probability (that is, assuming any precipitation occurs at all).
`abstract BigDecimal`	`precipIntensityMax()` Numerical values representing the maximumum expected intensity of precipitation on the given day in inches of liquid water per hour.
`abstract Long`	`precipIntensityMaxTime()` The UNIX time at which `precipIntensityMax()` occurs on the given day
`abstract BigDecimal`	`precipProbability()` A numerical value between 0 and 1 (inclusive) representing the probability of precipitation occurring at the given time.
`abstract FioPrecipType`	`precipType()` The type of precipitation occurring at the given time.
`abstract BigDecimal`	`pressure()` A numerical value representing the sea-level air pressure in millibars.
`abstract String`	`summary()` A human-readable text summary of this data point.
`abstract Long`	`sunriseTime()` The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) of the last sunrise before the solar noon closest to local noon on the given day.
`abstract Long`	`sunsetTime()` The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) of the first sunset after the solar noon closest to local noon on the given day.
`abstract BigDecimal`	`temperature()` A numerical value representing the temperature at the given time in degrees Fahrenheit.
`abstract BigDecimal`	`temperatureMax()` A numerical value representing the maximumum temperature on the given day in degrees Fahrenheit.
`abstract Long`	`temperatureMaxTime()` The UNIX time at which `temperatureMax()` occurs.
`abstract BigDecimal`	`temperatureMin()` Numerical values representing the minimum temperature on the given day in degrees Fahrenheit.
`abstract Long`	`temperatureMinTime()` The UNIX time at which `temperatureMin()` occurs.
`abstract long`	`time()` The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) at which this data point occurs
`abstract BigDecimal`	`visibility()` A numerical value representing the average visibility in miles, capped at 10 miles.
`abstract BigDecimal`	`windBearing()` A numerical value representing the direction that the wind is coming from in degrees, with true north at 0° and progressing clockwise.
`abstract BigDecimal`	`windSpeed()` A numerical value representing the wind speed in miles per hour.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FioDataPoint
```
public FioDataPoint()
```
- Method Detail
  - time
```
public abstract long time()
```
    The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) at which this data point occurs
  - summary
```
public abstract String summary()
```
    A human-readable text summary of this data point. (Do not use this value for automated purposes: you should use the icon property, instead.)
  - icon
```
public abstract FioIcon icon()
```
    A machine-readable text summary of this data point, suitable for selecting an icon for display.
  - sunriseTime
```
public abstract Long sunriseTime()
```
    The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) of the last sunrise before the solar noon closest to local noon on the given day. (Note: near the poles, these may occur on a different day entirely!)
    Only defined on daily data points
  - sunsetTime
```
public abstract Long sunsetTime()
```
    The UNIX time (that is, seconds since midnight GMT on 1 Jan 1970) of the first sunset after the solar noon closest to local noon on the given day. (Note: near the poles, these may occur on a different day entirely!)
    Only defined on daily data points
  - moonPhase
```
public abstract BigDecimal moonPhase()
```
    A number representing the fractional part of the lunation number of the given day: a value of 0 corresponds to a new moon, 0.25 to a first quarter moon, 0.5 to a full moon, and 0.75 to a last quarter moon. (The ranges in between these represent waxing crescent, waxing gibbous, waning gibbous, and waning crescent moons, respectively.)
    Only defined on daily data points
  - nearestStormDistance
```
public abstract BigDecimal nearestStormDistance()
```
    A numerical value representing the distance to the nearest storm in miles. (This value is very approximate and should not be used in scenarios requiring accurate results. In particular, a storm distance of zero doesn't necessarily refer to a storm at the requested location, but rather a storm in the vicinity of that location.)
    Only defined on currently data points
  - nearestStormBearing
```
public abstract BigDecimal nearestStormBearing()
```
    A numerical value representing the direction of the nearest storm in degrees, with true north at 0° and progressing clockwise. (If nearestStormDistance is zero, then this value will not be defined. The caveats that apply to nearestStormDistance also apply to this value.)
    Only defined on currently data points
  - precipIntensity
```
public abstract BigDecimal precipIntensity()
```
    A numerical value representing the average expected intensity (in inches of liquid water per hour) of precipitation occurring at the given time conditional on probability (that is, assuming any precipitation occurs at all). A very rough guide is that a value of 0 in./hr. corresponds to no precipitation, 0.002 in./hr. corresponds to very light precipitation, 0.017 in./hr. corresponds to light precipitation, 0.1 in./hr. corresponds to moderate precipitation, and 0.4 in./hr. corresponds to heavy precipitation.
  - precipIntensityMax
```
public abstract BigDecimal precipIntensityMax()
```
    Numerical values representing the maximumum expected intensity of precipitation on the given day in inches of liquid water per hour.
    Only defined on daily data points
  - precipIntensityMaxTime
```
public abstract Long precipIntensityMaxTime()
```
    The UNIX time at which precipIntensityMax() occurs on the given day
    Only defined on daily data points.
  - precipProbability
```
public abstract BigDecimal precipProbability()
```
    A numerical value between 0 and 1 (inclusive) representing the probability of precipitation occurring at the given time.
  - precipType
```
public abstract FioPrecipType precipType()
```
    The type of precipitation occurring at the given time. If precipIntensity() is zero, then this property will not be defined.)
  - precipAccumulation
```
public abstract BigDecimal precipAccumulation()
```
    The amount of snowfall accumulation expected to occur on the given day, in inches. (If no accumulation is expected, this property will not be defined.)
    Only defined on hourly and daily data points
  - temperature
```
public abstract BigDecimal temperature()
```
    A numerical value representing the temperature at the given time in degrees Fahrenheit.
    Not defined on daily data points.
  - temperatureMin
```
public abstract BigDecimal temperatureMin()
```
    Numerical values representing the minimum temperature on the given day in degrees Fahrenheit.
    Only defined on daily data points.
  - temperatureMinTime
```
public abstract Long temperatureMinTime()
```
    The UNIX time at which temperatureMin() occurs.
    Only defined on daily data points.
  - temperatureMax
```
public abstract BigDecimal temperatureMax()
```
    A numerical value representing the maximumum temperature on the given day in degrees Fahrenheit.
    Only defined on daily data points.
  - temperatureMaxTime
```
public abstract Long temperatureMaxTime()
```
    The UNIX time at which temperatureMax() occurs.
    Only defined on daily data points.
  - apparentTemperature
```
public abstract BigDecimal apparentTemperature()
```
    A numerical value representing the apparent (or "feels like") temperature at the given time in degrees Fahrenheit.
    Not defined on daily data points
  - apparentTemperatureMin
```
public abstract BigDecimal apparentTemperatureMin()
```
    A numerical value representing the minimum apparent temperature on the given day in degrees Fahrenheit.
    Only defined on daily data points.
  - apparentTemperatureMinTime
```
public abstract Long apparentTemperatureMinTime()
```
    The UNIX time at which apparentTemperatureMin() occurs.
    Only defined on daily data points.
  - apparentTemperatureMax
```
public abstract BigDecimal apparentTemperatureMax()
```
    A numerical value representing the maximumum apparent temperature on the given day in degrees Fahrenheit.
    Only defined on daily data points.
  - apparentTemperatureMaxTime
```
public abstract Long apparentTemperatureMaxTime()
```
    The UNIX time at which apparentTemperatureMax() occurs.
    Only defined on daily data points.
  - dewPoint
```
public abstract BigDecimal dewPoint()
```
    A numerical value representing the dew point at the given time in degrees Fahrenheit.
  - windSpeed
```
public abstract BigDecimal windSpeed()
```
    A numerical value representing the wind speed in miles per hour.
  - windBearing
```
public abstract BigDecimal windBearing()
```
    A numerical value representing the direction that the wind is coming from in degrees, with true north at 0° and progressing clockwise. (If windSpeed is zero, then this value will not be defined.)
  - cloudCover
```
public abstract BigDecimal cloudCover()
```
    A numerical value between 0 and 1 (inclusive) representing the percentage of sky occluded by clouds.
  - humidity
```
public abstract BigDecimal humidity()
```
    A numerical value between 0 and 1 (inclusive) representing the relative humidity.
  - pressure
```
public abstract BigDecimal pressure()
```
    A numerical value representing the sea-level air pressure in millibars.
  - visibility
```
public abstract BigDecimal visibility()
```
    A numerical value representing the average visibility in miles, capped at 10 miles.
  - ozone
```
public abstract BigDecimal ozone()
```
    A numerical value representing the columnar density of total atmospheric ozone at the given time in Dobson units.
  - getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```

Class FioDataPoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FioDataPoint

Method Detail

time

summary

icon

sunriseTime

sunsetTime

moonPhase

nearestStormDistance

nearestStormBearing

precipIntensity

precipIntensityMax

precipIntensityMaxTime

precipProbability

precipType

precipAccumulation

temperature

temperatureMin

temperatureMinTime

temperatureMax

temperatureMaxTime

apparentTemperature

apparentTemperatureMin

apparentTemperatureMinTime

apparentTemperatureMax

apparentTemperatureMaxTime

dewPoint

windSpeed

windBearing

cloudCover

humidity

pressure

visibility

ozone

getAdditionalProperty

getAdditionalProperties