]> granicus.if.org Git - postgis/commitdiff
Move over remainder of Geometry Accessors to new section. Fix ST_MemUnion (really...
authorRegina Obe <lr@pcorp.us>
Sun, 19 Oct 2008 14:40:53 +0000 (14:40 +0000)
committerRegina Obe <lr@pcorp.us>
Sun, 19 Oct 2008 14:40:53 +0000 (14:40 +0000)
git-svn-id: http://svn.osgeo.org/postgis/branches/1.3@3142 b70326c6-7e19-0410-871a-916f4a2858ee

postgis_comments.sql

index 6ba64914c878fde40ed353131b3726bd8118a513..c0f176889c40bf8278088a30183dc7a33089df23 100644 (file)
@@ -83,6 +83,8 @@ COMMENT ON FUNCTION ST_PointFromText(text , integer ) IS 'args: WKT, srid - Make
                        \r
 COMMENT ON FUNCTION ST_WKTToSQL(text ) IS 'args: WKT - Return a specified ST_Geometry value from Well-Known Text representation (WKT). This is an alias name for ST_GeomFromText';\r
                        \r
+COMMENT ON FUNCTION GeometryType(geometry ) IS 'args: geomA - eturns the type of the geometry as a string. Eg: LINESTRING, POLYGON, MULTIPOINT, etc.';\r
+                       \r
 COMMENT ON FUNCTION ST_Boundary(geometry ) IS 'args: geomA - Returns the closure of the combinatorial boundary of this Geometry.';\r
                        \r
 COMMENT ON FUNCTION ST_Dimension(geometry ) IS 'args: g - The inherent dimension of this Geometry object, which must be less than or equal to the coordinate dimension.';\r
@@ -101,10 +103,16 @@ COMMENT ON FUNCTION ST_InteriorRingN(geometry , integer ) IS 'args: a_polygon, n
                        \r
 COMMENT ON FUNCTION ST_IsClosed(geometry ) IS 'args: g - Returns TRUE if the LINESTRINGs start and end points are coincident.';\r
                        \r
+COMMENT ON FUNCTION ST_IsEmpty(geometry ) IS 'args: geomA - Returns true if this Geometry is an empty geometry . If true, then this Geometry represents the empty point set - i.e. GEOMETRYCOLLECTION(EMPTY).';\r
+                       \r
 COMMENT ON FUNCTION ST_IsRing(geometry ) IS 'args: g - Returns TRUE if this LINESTRING is both closed and simple.';\r
                        \r
+COMMENT ON FUNCTION ST_IsSimple(geometry ) IS 'args: geomA - Returns (TRUE) if this Geometry has no anomalous geometric points, such as self intersection or self tangency.';\r
+                       \r
 COMMENT ON FUNCTION ST_IsValid(geometry ) IS 'args: g - Returns true if the ST_Geometry is well formed.';\r
                        \r
+COMMENT ON FUNCTION ST_M(geometry ) IS 'args: a_point - Return the M coordinate of the point, or NULL if not available. Input must be a point.';\r
+                       \r
 COMMENT ON FUNCTION ST_NDims(geometry ) IS 'args: g1 - Returns coordinate dimension of the geometry as a small int. Values are: 2,3 or 4.';\r
                        \r
 COMMENT ON FUNCTION ST_NPoints(geometry ) IS 'args: g1 - Return the number of points (vertexes) in a geometry.';\r
@@ -125,6 +133,12 @@ COMMENT ON FUNCTION ST_StartPoint(geometry ) IS 'args: geomA - Returns the first
                        \r
 COMMENT ON FUNCTION ST_Summary(geometry ) IS 'args: g - Returns a text summary of the contents of the ST_Geometry.';\r
                        \r
+COMMENT ON FUNCTION ST_X(geometry ) IS 'args: a_point - Return the X coordinate of the point, or NULL if not available. Input must be a point.';\r
+                       \r
+COMMENT ON FUNCTION ST_X(geometry ) IS 'args: a_point - Return the Y coordinate of the point, or NULL if not available. Input must be a point.';\r
+                       \r
+COMMENT ON FUNCTION ST_Z(geometry ) IS 'args: a_point - Return the Z coordinate of the point, or NULL if not available. Input must be a point.';\r
+                       \r
 COMMENT ON FUNCTION ST_AddPoint(geometry, geometry) IS 'args: linestring, point - Adds a point to a LineString before point <position> (0-based index).';\r
                        \r
 COMMENT ON FUNCTION ST_AddPoint(geometry, geometry, integer) IS 'args: linestring, point, position - Adds a point to a LineString before point <position> (0-based index).';\r
@@ -253,7 +267,7 @@ COMMENT ON FUNCTION ST_MakePolygon(geometry, geometry[]) IS 'args: outerlinestri
                        \r
 COMMENT ON FUNCTION ST_Intersection(geometry, geometry) IS 'args: geomA, geomB - Returns a geometry that represents the shared portion of geomA and geomB';\r
                        \r
-COMMENT ON AGGREGATE ST_MemUnion(geometry) IS 'args: geomfield - Same as ST_Union, only memory-friendly (uses less memory and more processor time).';\r
+COMMENT ON AGGREGATE ST_MemGeomUnion(geometry) IS 'args: geomfield - Same as ST_Union, only memory-friendly (uses less memory and more processor time).';\r
                        \r
 COMMENT ON AGGREGATE ST_Polygonize(geometry) IS 'args: geomfield - Aggregate. Creates a GeometryCollection containing possible polygons formed from the constituent linework of a set of geometries.';\r
                        \r