Merge pull request #47 from JuliaGeo/rs/getrings

add getpolygons and getrings functions

Author: evetion

src/defaults.jl

@@ -37,16 +37,24 @@ getring(p::AbstractPolygonTrait, geom, i) = getgeom(p, geom, i)
 getexterior(p::AbstractPolygonTrait, geom) = getring(p, geom, 1)
 nhole(p::AbstractPolygonTrait, geom) = nring(p, geom) - 1
 gethole(p::AbstractPolygonTrait, geom, i) = getring(p, geom, i + 1)
+npoint(p::AbstractPolygonTrait, geom) = sum(npoint(p) for p in getring(p))
+getpoint(g::AbstractPolygonTrait, geom) = (p for p in getpoint(r) for r in getring(geom))
 
 ## MultiLineString
 nlinestring(p::AbstractMultiLineStringTrait, geom) = ngeom(p, geom)
 getlinestring(p::AbstractMultiLineStringTrait, geom) = getgeom(p, geom)
 getlinestring(p::AbstractMultiLineStringTrait, geom, i) = getgeom(p, geom, i)
+npoint(g::AbstractMultiLineStringTrait, geom) = sum(npoint(l) for ls in getlinestring(geom))
+getpoint(g::AbstractMultiLineStringTrait, geom) = (p for p in getpoint(ls) for l in getlinestring(geom))
 
 ## MultiPolygon
 npolygon(p::AbstractMultiPolygonTrait, geom) = ngeom(p, geom)
 getpolygon(p::AbstractMultiPolygonTrait, geom) = getgeom(p, geom)
 getpolygon(p::AbstractMultiPolygonTrait, geom, i) = getgeom(p, geom, i)
+nring(p::AbstractMultiPolygonTrait, geom) = sum(nring(p) for p in getpolygon(p))
+getring(g::AbstractMultiPolygonTrait, geom) = (r for r in getring(p) for p in getpolygon(geom))
+npoint(p::AbstractMultiPolygonTrait, geom) = sum(npoint(r) for r in getring(geom))
+getpoint(g::AbstractMultiPolygonTrait, geom) = (p for p in getpoint(r) for r in getring(geom))
 
 ## Surface
 npatch(p::AbstractPolyHedralSurfaceTrait, geom)::Integer = ngeom(p, geom)

src/interface.jl

@@ -84,7 +84,7 @@ Note that this is only valid for individual [`AbstractPoint`]s.
 """
 getcoord(geom, i::Integer) = getcoord(geomtype(geom), geom, i)
 """
-    getcoord(geom) -> Iterator
+    getcoord(geom) -> iterator
 """
 getcoord(geom) = getcoord(geomtype(geom), geom)
 
@@ -104,8 +104,11 @@ Return the `i`th Point in given `geom`.
 Note that this is only valid for [`AbstractCurve`](@ref)s and [`AbstractMultiPoint`](@ref)s.
 """
 getpoint(geom, i::Integer) = getpoint(geomtype(geom), geom, i)
+
 """
-    getpoint(geom) -> Iterator
+    getpoint(geom) -> iterator
+
+Returns an iterator over all points in `geom`.
 """
 getpoint(geom) = getpoint(geomtype(geom), geom)
 
@@ -191,19 +194,26 @@ boundary(geom) = boundary(geomtype(geom), geom)
     nring(geom) -> Integer
 
 Return the number of rings in given `geom`.
-Note that this is only valid for [`AbstractPolygon`](@ref)s.
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s
 """
 nring(geom) = nring(geomtype(geom), geom)
 
 """
     getring(geom, i::Integer) -> Int
 
 Return the `i`th ring for a given `geom`.
+
 Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 getring(geom, i::Integer) = getring(geomtype(geom), geom, i)
+
 """
-    getring(geom) -> Iterator
+    getring(geom) -> iterator
+
+Returns an iterator over all rings in `geom`.
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s in single-argument form.
 """
 getring(geom) = getring(geomtype(geom), geom)
 
@@ -215,23 +225,27 @@ Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 getexterior(geom) = getexterior(geomtype(geom), geom)
 
-
 """
     nhole(geom) -> Integer
 
 Returns the number of holes for this given `geom`.
 Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 nhole(geom)::Integer = nhole(geomtype(geom), geom)
+
 """
     gethole(geom, i::Integer) -> Curve
 
 Returns the `i`th interior ring for this given `geom`.
 Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 gethole(geom, i::Integer) = gethole(geomtype(geom), geom, i)
+
 """
-    gethole(geom) -> Iterator
+    gethole(geom) -> iterator
+
+Returns an iterator over all holes in `geom`.
+Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 gethole(geom) = gethole(geomtype(geom), geom)
 
@@ -251,8 +265,12 @@ Returns the `i`th patch for the given `geom`.
 Note that this is only valid for [`AbstractPolyHedralSurface`](@ref)s.
 """
 getpatch(geom, i::Integer) = getpatch(geomtype(geom), geom, i)
+
 """
-    getpatch(geom) -> Iterator
+    getpatch(geom) -> iterator
+
+Returns an iterator over all patches in `geom`.
+Note that this is only valid for [`AbstractPolyHedralSurface`](@ref)s.
 """
 getpatch(geom) = getpatch(geomtype(geom), geom)
 
@@ -277,8 +295,11 @@ ngeom(geom) = ngeom(geomtype(geom), geom)
 Returns the `i`th geometry for the given `geom`.
 """
 getgeom(geom, i::Integer) = getgeom(geomtype(geom), geom, i)
+
 """
-    getgeom(geom) -> Iterator
+    getgeom(geom) -> iterator
+
+Returns an iterator over all geometry components in `geom`.
 """
 getgeom(geom) = getgeom(geomtype(geom), geom)
 
@@ -298,8 +319,12 @@ Returns the `i`th linestring for the given `geom`.
 Note that this is only valid for [`AbstractMultiLineString`](@ref)s.
 """
 getlinestring(geom, i::Integer) = getlinestring(geomtype(geom), geom, i)
+
 """
-    getlinestring(geom) -> Iterator
+    getlinestring(geom) -> iterator
+
+Returns an iterator over all linestrings in a geometry.
+Note that this is only valid for [`AbstractMultiLineString`](@ref)s.
 """
 getlinestring(geom) = getlinestring(geomtype(geom), geom)
 
@@ -319,11 +344,33 @@ Returns the `i`th polygon for the given `geom`.
 Note that this is only valid for [`AbstractMultiPolygon`](@ref)s.
 """
 getpolygon(geom, i::Integer) = getpolygon(geomtype(geom), geom, i)
+
 """
-    getpolygon(geom) -> Iterator
+    getpolygon(geom) -> iterator
+
+Returns an iterator over all polygons in a geometry.
+Note that this is only valid for [`AbstractMultiPolygon`](@ref)s.
 """
 getpolygon(geom) = getpolygon(geomtype(geom), geom)
 
+"""
+    getring(geom, i::Integer) -> AbstractCurve
+
+A specific ring `i` in a polygon or multipolygon (exterior and holes).
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s.
+"""
+getring(geom, i::Integer) = getring(geomtype(geom), geom, i)
+
+"""
+    getring(geom) -> iterable
+
+Returns an iterator over all rings in a geometry.
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s.
+"""
+getring(geom) = getring(geomtype(geom), geom)
+
 # Other methods
 """
     crs(geom) -> T <: GeoFormatTypes.CoordinateReferenceSystemFormat