add flag to allow printing to stdout

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@58214 15284696-431f-4ddb-bdfa-cd5b030d7da7

vector/v.what.rast/main.c

@@ -2,12 +2,14 @@
  *
  * MODULE:       v.what.rast
  *  
- * AUTHOR(S):    Radim Blazek (using r.what)
- *               Michael Shapiro, U.S. Army Construction Engineering Research Laboratory (r.what)
- *                
+ * AUTHOR(S):    Radim Blazek (adapted from r.what)
+ *               Michael Shapiro, U.S. Army Construction Engineering
+ *                 Research Laboratory (r.what)
+ *               Hamish Bowman, University of Otago, NZ (interpolation)
+ *
  *  PURPOSE:      Query raster map
  *                
- *  COPYRIGHT:    (C) 2001, 2011 by the GRASS Development Team
+ *  COPYRIGHT:    (C) 2001-2013 by the GRASS Development Team
  * 
  *                This program is free software under the GNU General
  *                Public License (>=v2).  Read the file COPYING that
@@ -43,6 +45,7 @@ int main(int argc, char *argv[])
     {
 	struct Option *vect, *rast, *field, *col, *where;
     } opt;
+    struct Flag *print_flag;
     int Cache_size;
     struct order *cache;
     int cur_row;
@@ -87,19 +90,28 @@ int main(int argc, char *argv[])
     opt.rast->description = _("Name of existing raster map to be queried");
 
     opt.col = G_define_standard_option(G_OPT_DB_COLUMN);
-    opt.col->required = YES;
+    opt.col->required = NO;	/* YES, but suppress_required only for this option */
     opt.col->description =
 	_("Name of attribute column to be updated with the query result");
 
     opt.where = G_define_standard_option(G_OPT_DB_WHERE);
 
+    print_flag = G_define_flag();
+    print_flag->key = 'p';
+    print_flag->description =
+	_("Print categories and values instead of updating the database");
+
     if (G_parser(argc, argv))
 	exit(EXIT_FAILURE);
 
+
     db_init_string(&stmt);
     Points = Vect_new_line_struct();
     Cats = Vect_new_cats_struct();
 
+    if (!print_flag->answer && !opt.col->answer)
+	G_fatal_error(_("Required parameter <%s> not set"), opt.col->key);
+
     G_get_window(&window);
     Vect_region_box(&window, &box);	/* T and B set to +/- PORT_DOUBLE_MAX */
 
@@ -109,6 +121,7 @@ int main(int argc, char *argv[])
 
     field = Vect_get_field_number(&Map, opt.field->answer);
 
+    /* FIXME: if print flag is used then a database doesn't need to exist */
     Fi = Vect_get_field(&Map, field);
     if (Fi == NULL)
 	G_fatal_error(_("Database connection not defined for layer %d"),
@@ -136,20 +149,22 @@ int main(int argc, char *argv[])
        G_fatal_error ( "Cannot read category file");
      */
 
-    /* Check column type */
-    col_type = db_column_Ctype(driver, Fi->table, opt.col->answer);
+    if (!print_flag->answer) {
+	/* Check column type */
+	col_type = db_column_Ctype(driver, Fi->table, opt.col->answer);
 
-    if (col_type == -1)
-	G_fatal_error(_("Column <%s> not found"), opt.col->answer);
+	if (col_type == -1)
+	    G_fatal_error(_("Column <%s> not found"), opt.col->answer);
 
-    if (col_type != DB_C_TYPE_INT && col_type != DB_C_TYPE_DOUBLE)
-	G_fatal_error(_("Column type not supported"));
+	if (col_type != DB_C_TYPE_INT && col_type != DB_C_TYPE_DOUBLE)
+	    G_fatal_error(_("Column type not supported"));
 
-    if (out_type == CELL_TYPE && col_type == DB_C_TYPE_DOUBLE)
-	G_warning(_("Raster type is integer and column type is float"));
+	if (out_type == CELL_TYPE && col_type == DB_C_TYPE_DOUBLE)
+	    G_warning(_("Raster type is integer and column type is float"));
 
-    if (out_type != CELL_TYPE && col_type == DB_C_TYPE_INT)
-	G_warning(_("Raster type is float and column type is integer, some data lost!!"));
+	if (out_type != CELL_TYPE && col_type == DB_C_TYPE_INT)
+	    G_warning(_("Raster type is float and column type is integer, some data lost!!"));
+    }
 
     /* Read vector points to cache */
     Cache_size = Vect_get_num_primitives(&Map, GV_POINTS);
@@ -216,6 +231,7 @@ int main(int argc, char *argv[])
 	    cache[++i] = cache[j];
 	else
 	    cache[i].count++;
+
     point_cnt = i + 1;
 
     G_debug(1, "%d vector points left after removal of duplicates",
@@ -264,98 +280,136 @@ int main(int argc, char *argv[])
     }				/* point loop */
     Rast_close(fd);
 
-    /* Update table from cache */
-    G_debug(1, "Updating db table");
-
-    /* select existing categories to array (array is sorted) */
-    select = db_select_int(driver, Fi->table, Fi->key, NULL, &catexst);
 
-    db_begin_transaction(driver);
+    if (print_flag->answer) {
+	dupl_cnt = 0;
 
-    norec_cnt = update_cnt = upderr_cnt = dupl_cnt = 0;
+	G_message("%s|value", Fi->key);
 
-    G_message("Update vector attributes...");
-    for (point = 0; point < point_cnt; point++) {
-	if (cache[point].count > 1) {
-	    G_warning(_("More points (%d) of category %d, value set to 'NULL'"),
-		      cache[point].count, cache[point].cat);
-	    dupl_cnt++;
-	}
+	for (point = 0; point < point_cnt; point++) {
+	    if (cache[point].count > 1) {
+		G_warning(_("Multiple points (%d) of category %d, value set to 'NULL'"),
+			  cache[point].count, cache[point].cat);  /* TODO: improve message */
+		dupl_cnt++;
+	    }
 
-	G_percent(point, point_cnt, 2);
+	    fprintf(stdout, "%d|", cache[point].cat);
 
-	/* category exist in DB ? */
-	cex =
-	    (int *)bsearch((void *)&(cache[point].cat), catexst, select,
-			   sizeof(int), srch_cat);
-	if (cex == NULL) {	/* cat does not exist in DB */
-	    norec_cnt++;
-	    G_warning(_("No record for category %d in table <%s>"),
-		      cache[point].cat, Fi->table);
-	    continue;
+	    if (out_type == CELL_TYPE) {
+		if (cache[point].count > 1 ||
+		    Rast_is_c_null_value(&cache[point].value)) {
+		    fprintf(stdout, "*");
+		}
+		else
+		    fprintf(stdout, "%d", cache[point].value);
+	    }
+	    else {		/* FCELL or DCELL */
+		if (cache[point].count > 1 ||
+		    Rast_is_d_null_value(&cache[point].dvalue)) {
+		    fprintf(stdout, "*");
+		}
+		else
+		    fprintf(stdout, "%.*g", width, cache[point].dvalue);
+	    }
+	    fprintf(stdout, "\n");
 	}
+    }
+    else {
+	/* Update table from cache */
+	G_debug(1, "Updating db table");
 
-	sprintf(buf, "update %s set %s = ", Fi->table, opt.col->answer);
+	/* select existing categories to array (array is sorted) */
+	select = db_select_int(driver, Fi->table, Fi->key, NULL, &catexst);
 
-	db_set_string(&stmt, buf);
+	db_begin_transaction(driver);
 
-	if (out_type == CELL_TYPE) {
-	    if (cache[point].count > 1 ||
-		Rast_is_c_null_value(&cache[point].value)) {
-		sprintf(buf, "NULL");
+	norec_cnt = update_cnt = upderr_cnt = dupl_cnt = 0;
+
+	G_message("Update vector attributes...");
+	for (point = 0; point < point_cnt; point++) {
+	    if (cache[point].count > 1) {
+		G_warning(_("Multiple points (%d) of category %d, value set to 'NULL'"),
+			  cache[point].count, cache[point].cat);
+		dupl_cnt++;
 	    }
-	    else {
-		sprintf(buf, "%d ", cache[point].value);
+
+	    G_percent(point, point_cnt, 2);
+
+	    /* category exist in DB ? */
+	    cex =
+		(int *)bsearch((void *)&(cache[point].cat), catexst, select,
+			       sizeof(int), srch_cat);
+	    if (cex == NULL) {	/* cat does not exist in DB */
+		norec_cnt++;
+		G_warning(_("No record for category %d in table <%s>"),
+			  cache[point].cat, Fi->table);
+		continue;
 	    }
-	}
-	else {			/* FCELL or DCELL */
-	    if (cache[point].count > 1 ||
-		Rast_is_d_null_value(&cache[point].dvalue)) {
-		sprintf(buf, "NULL");
+
+	    sprintf(buf, "update %s set %s = ", Fi->table, opt.col->answer);
+
+	    db_set_string(&stmt, buf);
+
+	    if (out_type == CELL_TYPE) {
+		if (cache[point].count > 1 ||
+		    Rast_is_c_null_value(&cache[point].value)) {
+		    sprintf(buf, "NULL");
+		}
+		else
+		    sprintf(buf, "%d ", cache[point].value);
 	    }
-	    else {
-		sprintf(buf, "%.*g", width, cache[point].dvalue);
+	    else {		/* FCELL or DCELL */
+		if (cache[point].count > 1 ||
+		    Rast_is_d_null_value(&cache[point].dvalue)) {
+		    sprintf(buf, "NULL");
+		}
+		else
+		    sprintf(buf, "%.*g", width, cache[point].dvalue);
 	    }
-	}
-	db_append_string(&stmt, buf);
+	    db_append_string(&stmt, buf);
 
-	sprintf(buf, " where %s = %d", Fi->key, cache[point].cat);
-	db_append_string(&stmt, buf);
-	/* user provides where condition: */
-	if (opt.where->answer) {
-	    sprintf(buf, " AND %s", opt.where->answer);
+	    sprintf(buf, " where %s = %d", Fi->key, cache[point].cat);
 	    db_append_string(&stmt, buf);
-	}
-	G_debug(3, db_get_string(&stmt));
+	    /* user provides where condition: */
+	    if (opt.where->answer) {
+		sprintf(buf, " AND %s", opt.where->answer);
+		db_append_string(&stmt, buf);
+	    }
+	    G_debug(3, db_get_string(&stmt));
 
-	/* Update table */
-	if (db_execute_immediate(driver, &stmt) == DB_OK) {
-	    update_cnt++;
-	}
-	else {
-	    upderr_cnt++;
+	    /* Update table */
+	    if (db_execute_immediate(driver, &stmt) == DB_OK) {
+		update_cnt++;
+	    }
+	    else {
+		upderr_cnt++;
+	    }
 	}
-    }
-    G_percent(1, 1, 1);
+	G_percent(1, 1, 1);
 
-    G_debug(1, "Committing DB transaction");
-    db_commit_transaction(driver);
+	G_debug(1, "Committing DB transaction");
+	db_commit_transaction(driver);
 
-    G_free(catexst);
-    db_close_database_shutdown_driver(driver);
-    db_free_string(&stmt);
+	G_free(catexst);
+	db_close_database_shutdown_driver(driver);
+	db_free_string(&stmt);
+    }
 
     /* Report */
     G_verbose_message(_("%d categories loaded from table"), select);
     G_verbose_message(_("%d categories loaded from vector"), point_cnt);
-    G_verbose_message(_("%d categories from vector missing in table"),
-		      norec_cnt);
+    if (!print_flag->answer)
+	G_verbose_message(_("%d categories from vector missing in table"),
+			  norec_cnt);
     if (dupl_cnt > 0)
 	G_message(_("%d duplicate categories in vector"), dupl_cnt);
-    if (upderr_cnt > 0)
-	G_warning(_("%d update errors"), upderr_cnt);
 
-    G_done_msg(_("%d records updated."), update_cnt);
+    if (!print_flag->answer) {
+	if (upderr_cnt > 0)
+	    G_warning(_("%d update errors"), upderr_cnt);
+
+	G_done_msg(_("%d records updated."), update_cnt);
+    }
 
     exit(EXIT_SUCCESS);
 }

vector/v.what.rast/v.what.rast.html

@@ -1,16 +1,27 @@
 <h2>DESCRIPTION</h2>
 
-<em>v.what.rast</em> reads raster value for each point in the vector and updates <b>col</b> 
-column in vector attribute table by this value. The column should be type
-number (integer, float, double, ... ).
+<em>v.what.rast</em> reads the raster value for each point in the vector map
+and updates <b>column</b> in the vector attribute table by this value. The
+column should be type number (integer, float, double, ... ).
 <br>
-If more points have the same category, attribute value is set to NULL.
-If raster values is NULL, attribute value is set to NULL.
+If multiple points have the same category, the attribute value is set to NULL.
+If the raster value is NULL, then attribute value is set to NULL.
+<p>
+If the <b>-p</b> flag is used, then the attribute table is not updated
+and the results are printed to <tt>stdout</tt>.
+
 
 <h2>NOTES</h2>
 
 <em>v.what.rast</em> operates on the attribute table. To modify the vector
 geometry instead, use <em>v.drape</em>.
+<p>
+Categories and values are output unsorted with the print flag. To sort them
+pipe the output of this module into the UNIX <tt>sort</tt> tool
+(<tt>sort&nbsp;-n</tt>). If you need coordinates, after sorting use
+<em>v.out.ascii</em> and the UNIX <tt>paste</tt> tool
+(<tt>paste&nbsp;-d'|'</tt>).
+
 
 <h2>EXAMPLES</h2>
 
@@ -44,6 +55,7 @@ v.db.select pnts
 v.univar map=pnts column=heights type=point
 </pre></div>
 
+
 <h2>SEE ALSO</h2>
 
 <em>
@@ -55,6 +67,7 @@ v.univar map=pnts column=heights type=point
 <a href="v.what.vect.html">v.what.vect</a>
 </em>
 
+
 <h2>AUTHOR</h2>
 Radim Blazek