Module: USGeo::Area

Included in:
CombinedStatisticalArea, CoreBasedStatisticalArea, County, CountySubdivision, Division, MetropolitanDivision, Place, Region, State, UrbanArea, UrbanAreaCounty, UrbanAreaCountySubdivision, Zcta, ZctaCounty, ZctaCountySubdivision, ZctaPlace, ZctaUrbanArea
Defined in:
lib/us_geo/area.rb

Overview

This module is mixed into all models. Note that the area given for land and water is in square miles.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#land_area ⇒ Float?

Returns Land area in square miles.

Returns:

  • (Float, nil) —

    Land area in square miles.




# File 'lib/us_geo/area.rb', line 10

#water_area ⇒ Integer?

Returns Water area in square miles.

Returns:

  • (Integer, nil) —

    Water area in square miles.




# File 'lib/us_geo/area.rb', line 13

Instance Method Details

#land_area_km ⇒ Float?

Land area in square kilometers.

Returns:

  • (Float, nil) 


33
34
35
 
# File 'lib/us_geo/area.rb', line 33

def land_area_km
  land_area * SQUARE_MILES_TO_KILOMETERS if land_area
end

#percent_land ⇒ Float?

The fraction of the area that is composed of land instead of water.

Returns:

  • (Float, nil) 


26
27
28
 
# File 'lib/us_geo/area.rb', line 26

def percent_land
  land_area / total_area if land_area
end

#total_area ⇒ Float?

Total area of both land an water in square miles.

Returns:

  • (Float, nil) 


19
20
21
 
# File 'lib/us_geo/area.rb', line 19

def total_area
  land_area.to_f + water_area.to_f if land_area
end

#water_area_km ⇒ Float?

Water area in square kilometers.

Returns:

  • (Float, nil) 


40
41
42
 
# File 'lib/us_geo/area.rb', line 40

def water_area_km
  water_area * SQUARE_MILES_TO_KILOMETERS if water_area
end