[postgis-commits] svn - r3849 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: kneufeld
Date: 2009-03-10 21:35:05 -0700 (Tue, 10 Mar 2009)
New Revision: 3849

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
moved over ST_GeomFromWKB

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2009-03-10 21:29:14 UTC (rev 3848)
+++ trunk/doc/reference.xml	2009-03-11 04:35:05 UTC (rev 3849)
@@ -25,18 +25,6 @@
       <variablelist>
 
         <varlistentry>
-          <term>ST_GeometryFromWKB(bytea,[&lt;srid&gt;])</term>
-
-          <listitem>
-            <para>Makes a Geometry from WKB with the given SRID. If SRID is
-            not give, it defaults to -1.</para>
-
-            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
-            suite</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_PointFromWKB(bytea,[&lt;srid&gt;])</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-03-10 21:29:14 UTC (rev 3848)
+++ trunk/doc/reference_new.xml	2009-03-11 04:35:05 UTC (rev 3849)
@@ -1066,6 +1066,7 @@
 			<para><xref linkend="ST_BuildArea" />, <xref linkend="ST_BdMPolyFromText" /></para>
 		  </refsection>
 		</refentry>
+		
 		<refentry id="ST_BdMPolyFromText">
 			<refnamediv>
 				<refname>ST_BdMPolyFromText</refname>
@@ -1334,6 +1335,7 @@
 		<para><xref linkend="ST_AsEWKT" />, <xref linkend="ST_GeomFromText" />, <xref linkend="ST_GeomFromEWKT" /></para>
 	  </refsection>
 	</refentry>
+	
 	<refentry id="ST_GeometryFromText">
 		  <refnamediv>
 			<refname>ST_GeometryFromText</refname>
@@ -1374,6 +1376,7 @@
 			<para><xref linkend="ST_GeomFromText" /></para>
 		  </refsection>
 	</refentry>
+	
 	<refentry id="ST_GeomFromText">
 		  <refnamediv>
 			<refname>ST_GeomFromText</refname>
@@ -1478,19 +1481,20 @@
 	<refentry id="ST_GeomFromWKB">
 	  <refnamediv>
 		<refname>ST_GeomFromWKB</refname>
-		<refpurpose>Return a specified ST_Geometry value from Well-Known Binary representation (WKB) and optional srid.</refpurpose>
+		<refpurpose>Creates a geometry instance from a Well-Known Binary geometry 
+		representation (WKB) and optional SRID.</refpurpose>
 	  </refnamediv>
 
 	  <refsynopsisdiv>
 		<funcsynopsis>
 		  <funcprototype>
 			<funcdef>geometry <function>ST_GeomFromWKB</function></funcdef>
-			<paramdef><type>bytea </type> <parameter>geomA</parameter></paramdef>
+			<paramdef><type>bytea </type> <parameter>geom</parameter></paramdef>
 		  </funcprototype>
 
 		  <funcprototype>
 			<funcdef>geometry <function>ST_GeomFromWKB</function></funcdef>
-			<paramdef><type>bytea </type> <parameter>geomA</parameter></paramdef>
+			<paramdef><type>bytea </type> <parameter>geom</parameter></paramdef>
 			<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
 		  </funcprototype>
 		</funcsynopsis>
@@ -1499,9 +1503,13 @@
 	  <refsection>
 		<title>Description</title>
 
-		<para>Return a specified ST_Geometry value from Well-Known Binary representation (WKB) and optinal srid.  This is an alternate name for ST_WKBToSQL</para>
+		<para>The <varname>ST_GeomFromWKB</varname> function, takes a well-known 
+		binary representation of a geometry and a Spatial Reference System ID 
+		(<varname>SRID</varname>) and creates an instance of the appropriate 
+		geometry type. This function plays the role of the Geometry Factory in 
+		SQL. This is an alternate name for ST_WKBToSQL.</para>
 
-		<para>If SRID is not give, it defaults to -1 (UnKnown).</para>
+		<para>If SRID is not specified, it defaults to -1 (Unknown).</para>
 
 		<!-- Optionally mention OpenGIS compliancy if appropriate -->
 		<para><inlinemediaobject>
@@ -1510,16 +1518,16 @@
 			</imageobject>
 		  </inlinemediaobject> This method implements the <ulink
 		url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
-		Implementation Specification for SQL. OGC SPEC 3.2.6.2 - option SRID is from the conformance suite</ulink></para>
+		Implementation Specification for SQL. OGC SPEC 3.2.7.2 - the optional SRID is from the conformance suite</ulink></para>
 
 		<!-- Optionally mention SQL/MM compliancy if appropriate -->
 		<para><inlinemediaobject>
 			<imageobject>
 			  <imagedata fileref="images/check.png" />
 			</imageobject>
-		  </inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 5.1.41</para>
+		  </inlinemediaobject>This method implements the SQL/MM specification: SQL-MM 3: 5.1.41</para>
 
-	<!-- Optionally mention Circular String Support -->
+	`	<!-- Optionally mention Circular String Support -->
 			<para><inlinemediaobject>
 				<imageobject>
 				  <imagedata fileref="images/check.png" />
@@ -1531,14 +1539,25 @@
 	  <refsection>
 		<title>Examples</title>
 
-		<programlisting>
---Although bytea rep contains single \, these need to be escaped when inserting into a table
+		<programlisting>--Although bytea rep contains single \, these need to be escaped when inserting into a table
 SELECT ST_AsEWKT(
 ST_GeomFromWKB(E'\\001\\002\\000\\000\\000\\002\\000\\000\\000\\037\\205\\353Q\\270~\\\\\\300\\323Mb\\020X\\231C@\\020X9\\264\\310~\\\\\\300)\\\\\\217\\302\\365\\230C@',4326)
 );
---result--
-SRID=4326;LINESTRING(-113.98 39.198,-113.981 39.195)
-</programlisting>
+                      st_asewkt                       
+------------------------------------------------------
+ SRID=4326;LINESTRING(-113.98 39.198,-113.981 39.195)
+(1 row)
+
+SELECT 
+  ST_AsText(
+    ST_PointFromWKB(
+      ST_AsEWKB('POINT(2 5)'::geometry)
+    )
+  );
+ st_astext  
+------------
+ POINT(2 5)
+(1 row)</programlisting>
 	  </refsection>
 
 	  <!-- Optionally add a "See Also" section -->