123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989 |
- /*!
- \file lib/gis/parser_standard_options.c
-
- \brief GIS Library - Argument parsing functions (standard options)
-
- (C) 2001-2019 by the GRASS Development Team
-
- This program is free software under the GNU General Public License
- (>=v2). Read the file COPYING that comes with GRASS for details.
-
- \author Original author CERL
- \author Soeren Gebbert added Dec. 2009 WPS process_description document
- \author Luca Delucchi added Aug 2011 G_OPT_M_DIR
- */
- #include <grass/gis.h>
- #include <grass/glocale.h>
- #include "parser_local_proto.h"
- /*!
- \brief Create standardised Option structure.
-
- This function will create a standardised Option structure defined by
- parameter <i>opt</i>.
- Valid parameters are defined by the STD_OPT enum in the file gis.h.
- A list of valid parameter values sorted to groups is below.
- This function allocates memory for the Option structure and returns a
- pointer to this memory.
- If an invalid parameter was specified a empty Option structure will
- be returned (not NULL).
- Values also need to be added to general/g.parser/standard_option.c
- \par List of STD_OPT values sorted by module group
- - database:
- - G_OPT_DB_SQL
- - G_OPT_DB_WHERE
- - G_OPT_DB_TABLE
- - G_OPT_DB_DRIVER
- - G_OPT_DB_DATABASE
- - G_OPT_DB_SCHEMA
- - G_OPT_DB_COLUMN
- - G_OPT_DB_COLUMNS
- - G_OPT_DB_KEYCOLUMN
- - imagery:
- - G_OPT_I_GROUP
- - G_OPT_I_SUBGROUP
- - raster:
- - G_OPT_MEMORYMB
- - G_OPT_R_INPUT
- - G_OPT_R_INPUTS
- - G_OPT_R_OUTPUT
- - G_OPT_R_MAP
- - G_OPT_R_MAPS
- - G_OPT_R_BASE
- - G_OPT_R_COVER
- - G_OPT_R_ELEV
- - G_OPT_R_ELEVS
- - G_OPT_R_TYPE
- - G_OPT_R_INTERP_TYPE
- - G_OPT_R_BASENAME_INPUT
- - G_OPT_R_BASENAME_OUTPUT
- - raster3d:
- - G_OPT_R3_INPUT
- - G_OPT_R3_INPUTS
- - G_OPT_R3_OUTPUT
- - G_OPT_R3_MAP
- - G_OPT_R3_MAPS
-
- - vector:
- - G_OPT_V_INPUT
- - G_OPT_V_INPUTS
- - G_OPT_V_OUTPUT
- - G_OPT_V_MAP
- - G_OPT_V_MAPS
- - G_OPT_V_TYPE
- - G_OPT_V_FIELD
- - G_OPT_V_FIELD_ALL
- - G_OPT_V_CAT
- - G_OPT_V_CATS
- - G_OPT_V_ID
- - G_OPT_V_IDS
-
- - files
- - G_OPT_F_INPUT
- - G_OPT_F_BIN_INPUT
- - G_OPT_F_OUTPUT
- - G_OPT_F_SEP
-
- - colors
- - G_OPT_C
- - G_OPT_CN
- - misc
- - G_OPT_M_DIR
- - G_OPT_M_UNITS
- - G_OPT_M_DATATYPE
- - G_OPT_M_MAPSET
- - G_OPT_M_LOCATION
- - G_OPT_M_DBASE
- - G_OPT_M_COORDS
- - G_OPT_M_COLR
- - G_OPT_M_REGION
- - G_OPT_M_NULL_VALUE
- - G_OPT_M_NPROCS
- - temporal GIS framework
- - G_OPT_STDS_INPUT
- - G_OPT_STDS_INPUTS
- - G_OPT_STDS_OUTPUT
- - G_OPT_STRDS_INPUT
- - G_OPT_STRDS_INPUTS
- - G_OPT_STRDS_OUTPUT
- - G_OPT_STRDS_OUTPUTS
- - G_OPT_STR3DS_INPUT
- - G_OPT_STR3DS_INPUTS
- - G_OPT_STR3DS_OUTPUT
- - G_OPT_STVDS_INPUT
- - G_OPT_STVDS_INPUTS
- - G_OPT_STVDS_OUTPUT
- - G_OPT_MAP_INPUT
- - G_OPT_MAP_INPUTS
- - G_OPT_STDS_TYPE
- - G_OPT_MAP_TYPE
- - G_OPT_T_TYPE
- - G_OPT_T_WHERE
- \param opt type of Option struct to create specified by STD_OPT enum
- \return pointer to an Option struct
- */
- struct Option *G_define_standard_option(int opt)
- {
- struct Option *Opt;
- char *memstr;
- Opt = G_define_option();
- switch (opt) {
- case G_OPT_DB_SQL:
- Opt->key = "sql";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "sql_query";
- Opt->required = NO;
- Opt->label = _("SQL SELECT statement");
- Opt->description =
- _("Example: select * from towns where population > 10000");
- break;
- case G_OPT_DB_WHERE:
- Opt->key = "where";
- Opt->type = TYPE_STRING;
- Opt->gisprompt = "old,sql_query,sql_query";
- Opt->key_desc = "sql_query";
- Opt->required = NO;
- Opt->label = _("WHERE conditions of SQL statement without 'where' keyword");
- Opt->description = _("Example: income < 1000 and population >= 10000");
- break;
- case G_OPT_DB_TABLE:
- Opt->key = "table";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Name of attribute table");
- Opt->gisprompt = "old,dbtable,dbtable";
- break;
- case G_OPT_DB_DRIVER:
- Opt->key = "driver";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Name of database driver");
- Opt->gisprompt = "old,dbdriver,dbdriver";
- break;
- case G_OPT_DB_DATABASE:
- Opt->key = "database";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Name of database");
- Opt->gisprompt = "old,dbname,dbname";
- break;
- case G_OPT_DB_SCHEMA:
- Opt->key = "schema";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->label = _("Database schema");
- Opt->description = _("Do not use this option if schemas "
- "are not supported by driver/database server");
- break;
- case G_OPT_DB_COLUMN:
- Opt->key = "column";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Name of attribute column");
- Opt->gisprompt = "old,dbcolumn,dbcolumn";
- break;
- case G_OPT_DB_COLUMNS:
- Opt->key = "columns";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->description = _("Name of attribute column(s)");
- Opt->gisprompt = "old,dbcolumn,dbcolumn";
- break;
- case G_OPT_DB_KEYCOLUMN:
- Opt->key = "key";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->label = _("Name of key column");
- Opt->description = _("Must refer to an integer column");
- /* Opt->gisprompt = "old,dbcolumn,dbcolumn"; */
- Opt->answer = GV_KEY_COLUMN;
- break;
- /* imagery group */
- case G_OPT_I_GROUP:
- Opt->key = "group";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,group,group";
- Opt->description = _("Name of input imagery group");
- break;
- case G_OPT_I_SUBGROUP:
- Opt->key = "subgroup";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,subgroup,subgroup";
- Opt->description = _("Name of input imagery subgroup");
- break;
- /* raster maps */
- case G_OPT_MEMORYMB:
- Opt->key = "memory";
- Opt->type = TYPE_INTEGER;
- Opt->key_desc = "memory in MB";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->answer = "300";
- /* start dynamic answer */
- /* check MEMORYMB in GISRC, set with g.gisenv */
- memstr = G_store(G_getenv_nofatal("MEMORYMB"));
- if (memstr && *memstr)
- Opt->answer = memstr;
- /* end dynamic answer */
- Opt->label = _("Maximum memory to be used (in MB)");
- Opt->description = _("Cache size for raster rows");
- break;
- case G_OPT_R_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map");
- break;
- case G_OPT_R_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map(s)");
- break;
- case G_OPT_R_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,cell,raster";
- Opt->description = _("Name for output raster map");
- break;
- case G_OPT_R_OUTPUTS:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "new,cell,raster";
- Opt->description = _("Name for output raster map(s)");
- break;
- case G_OPT_R_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of raster map");
- break;
- case G_OPT_R_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of raster map(s)");
- break;
- case G_OPT_R_BASE:
- Opt->key = "base";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of base raster map");
- break;
- case G_OPT_R_COVER:
- Opt->key = "cover";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of cover raster map");
- break;
- case G_OPT_R_ELEV:
- Opt->key = "elevation";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input elevation raster map");
- break;
- case G_OPT_R_ELEVS:
- Opt->key = "elevation";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input elevation raster map(s)");
- break;
- case G_OPT_R_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->required = YES;
- Opt->multiple = NO;
- Opt->label = _("Type of raster map to be created");
- Opt->description = _("Storage type for resultant raster map");
- Opt->options = "CELL,FCELL,DCELL";
- G_asprintf((char **) &(Opt->descriptions),
- "CELL;%s;FCELL;%s;DCELL;%s",
- _("Integer"),
- _("Single precision floating point"),
- _("Double precision floating point"));
- break;
- case G_OPT_R_INTERP_TYPE:
- Opt->key = "method";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->description = _("Sampling interpolation method");
- Opt->options = "nearest,bilinear,bicubic";
- G_asprintf((char **) &(Opt->descriptions),
- "nearest;%s;bilinear;%s;bicubic;%s",
- _("Nearest-neighbor interpolation"),
- _("Bilinear interpolation"),
- _("Bicubic interpolation"));
- break;
- case G_OPT_R_BASENAME_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "basename";
- Opt->required = YES;
- Opt->multiple = NO;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input basename raster map(s)");
- break;
- case G_OPT_R_BASENAME_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "basename";
- Opt->required = YES;
- Opt->multiple = NO;
- Opt->gisprompt = "new,cell,raster";
- Opt->description = _("Name for output basename raster map(s)");
- break;
- /*g3d maps */
- case G_OPT_R3_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,grid3,raster_3d";
- Opt->description = _("Name of input 3D raster map");
- break;
- case G_OPT_R3_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,grid3,raster_3d";
- Opt->description = _("Name of input 3D raster map(s)");
- break;
- case G_OPT_R3_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,grid3,raster_3d";
- Opt->description = _("Name for output 3D raster map");
- break;
- case G_OPT_R3_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,grid3,raster_3d";
- Opt->description = _("Name of 3D raster map");
- break;
- case G_OPT_R3_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,grid3,raster_3d";
- Opt->description = _("Name of 3D raster map(s)");
- break;
- case G_OPT_R3_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->answer = "default";
- Opt->options = "default,double,float";
- Opt->description = _("Data type used in the output raster3d map");
- break;
- case G_OPT_R3_PRECISION:
- Opt->key = "precision";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->answer = "default";
- Opt->description =
- _("Number of digits used as mantissa in the internal map storage, 0 -23 for float, 0 - 52 for double, max or default");
- break;
- case G_OPT_R3_COMPRESSION:
- Opt->key = "compression";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->answer = "default";
- Opt->options = "default,zip,none";
- Opt->description =
- _("The compression method used in the output raster3d map");
- break;
- case G_OPT_R3_TILE_DIMENSION:
- Opt->key = "tiledimension";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->key_desc = "XxYxZ";
- Opt->answer = "default";
- Opt->description =
- _("The dimensions of the tiles used in the output raster3d map (XxYxZ or default: 16x16x8)");
- break;
- /*vector maps */
- case G_OPT_V_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->label = _("Name of input vector map");
- Opt->description = _("Or data source for direct OGR access");
- break;
- case G_OPT_V_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->label = _("Name of input vector map(s)");
- Opt->description = _("Or data source(s) for direct OGR access");
- break;
- case G_OPT_V_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,vector,vector";
- Opt->description = _("Name for output vector map");
- break;
- case G_OPT_V_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->label = _("Name of vector map");
- Opt->description = _("Or data source for direct OGR access");
- break;
- case G_OPT_V_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->description = _("Name of vector map(s)");
- break;
- case G_OPT_V_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->answer = "point,line,boundary,centroid,area";
- Opt->options = "point,line,boundary,centroid,area";
- Opt->description = _("Input feature type");
- break;
- case G_OPT_V3_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->answer = "point,line,boundary,centroid,area,face,kernel";
- Opt->options = "point,line,boundary,centroid,area,face,kernel";
- Opt->description = _("Input feature type");
- break;
- case G_OPT_V_FIELD:
- Opt->key = "layer";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->answer = "1";
- Opt->label = _("Layer number or name");
- Opt->description =
- _("Vector features can have category values in different layers."
- " This number determines which layer to use. "
- "When used with direct OGR access this is the layer name.");
- Opt->gisprompt = "old,layer,layer";
- break;
- case G_OPT_V_FIELD_ALL:
- Opt->key = "layer";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->answer = "-1";
- Opt->label = _("Layer number or name ('-1' for all layers)");
- Opt->description =
- _("A single vector map can be connected to multiple database "
- "tables. This number determines which table to use. "
- "When used with direct OGR access this is the layer name.");
- Opt->gisprompt = "old,layer_all,layer";
- break;
- case G_OPT_V_CAT:
- Opt->key = "cat";
- Opt->type = TYPE_INTEGER;
- Opt->required = NO;
- Opt->description = _("Category value");
- Opt->gisprompt = "old,cat,cats";
- break;
- case G_OPT_V_CATS:
- Opt->key = "cats";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "range";
- Opt->required = NO;
- Opt->label = _("Category values");
- Opt->description = _("Example: 1,3,7-9,13");
- Opt->gisprompt = "old,cats,cats";
- break;
- case G_OPT_V_ID:
- Opt->key = "id";
- Opt->type = TYPE_INTEGER;
- Opt->required = NO;
- Opt->description = _("Feature id");
- break;
- case G_OPT_V_IDS:
- Opt->key = "ids";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "range";
- Opt->required = NO;
- Opt->label = _("Feature ids");
- Opt->description = _("Example: 1,3,7-9,13");
- break;
- /* files */
- case G_OPT_F_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,file,file";
- Opt->description = _("Name of input file");
- break;
- case G_OPT_F_BIN_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,bin,file";
- Opt->description = _("Name of input file");
- break;
- case G_OPT_F_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,file,file";
- Opt->description = _("Name for output file");
- break;
- case G_OPT_F_SEP:
- Opt->key = "separator";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "character";
- Opt->required = NO;
- Opt->gisprompt = "old,separator,separator";
- Opt->answer = "pipe";
- Opt->label = _("Field separator");
- Opt->description = _("Special characters: pipe, comma, space, tab, newline");
- break;
- /* colors */
- case G_OPT_C:
- Opt->key = "color";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = DEFAULT_FG_COLOR;
- Opt->gisprompt = "old,color,color";
- Opt->label = _("Color");
- Opt->description =
- _("Either a standard color name or R:G:B triplet");
- break;
- case G_OPT_CN:
- Opt->key = "color";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = DEFAULT_FG_COLOR;
- Opt->gisprompt = "old,color_none,color";
- Opt->label = _("Color");
- Opt->description =
- _("Either a standard color name, R:G:B triplet, or \"none\"");
- break;
- /* misc */
- case G_OPT_M_DIR:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,dir,dir";
- Opt->description = _("Name of input directory");
- break;
- case G_OPT_M_UNITS:
- Opt->key = "units";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->options =
- "miles,feet,meters,kilometers,acres,hectares";
- Opt->description = _("Units");
- break;
-
- case G_OPT_M_DATATYPE:
- Opt->key = "type";
- Opt->key_desc = "datatype";
- Opt->type = TYPE_STRING;
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->description = _("Data type(s)");
- break;
- case G_OPT_M_MAPSET:
- Opt->key = "mapset";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->key_desc = "name";
- Opt->gisprompt = "old,mapset,mapset";
- Opt->label = _("Name of mapset (default: current search path)");
- Opt->description = _("'.' for current mapset");
- break;
-
- case G_OPT_M_LOCATION:
- Opt->key = "location";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->label = _("Location name");
- Opt->description = _("Location name (not location path)");
- Opt->gisprompt = "old,location,location";
- Opt->key_desc = "name";
- break;
- case G_OPT_M_DBASE:
- Opt->key = "dbase";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->label = _("GRASS GIS database directory");
- Opt->description = _("Default: path to the current GRASS GIS database");
- Opt->gisprompt = "old,dbase,dbase";
- Opt->key_desc = "path";
- break;
- case G_OPT_M_COORDS:
- Opt->key = "coordinates";
- Opt->type = TYPE_DOUBLE;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->key_desc = "east,north";
- Opt->gisprompt = "old,coords,coords";
- Opt->description = _("Coordinates");
- break;
- case G_OPT_M_COLR:
- Opt->key = "color";
- Opt->key_desc = "style";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->options = G_color_rules_options();
- Opt->description = _("Name of color table");
- Opt->descriptions = G_color_rules_description_type();
- Opt->gisprompt = "old,colortable,colortable";
- break;
-
- case G_OPT_M_NULL_VALUE:
- Opt->key = "null_value";
- Opt->key_desc = "string";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("String representing NULL value");
- break;
-
- case G_OPT_M_REGION:
- Opt->key = "region";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->gisprompt = "old,windows,region";
- Opt->description = _("Name of saved region");
- break;
- case G_OPT_M_NPROCS:
- Opt->key = "nprocs";
- Opt->type = TYPE_INTEGER;
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->answer = "1";
- /* start dynamic answer */
- /* check NPROCS in GISRC, set with g.gisenv */
- memstr = G_store(G_getenv_nofatal("NPROCS"));
- if (memstr && *memstr)
- Opt->answer = memstr;
- /* end dynamic answer */
- Opt->description = _("Number of threads for parallel computing");
- break;
- /* Spatio-temporal modules of the temporal GIS framework */
- case G_OPT_STDS_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,stds,stds";
- Opt->description = _("Name of the input space time dataset");
- break;
- case G_OPT_STDS_INPUTS:
- Opt->key = "inputs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,stds,stds";
- Opt->description = _("Name of the input space time datasets");
- break;
- case G_OPT_STDS_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,stds,stds";
- Opt->description = _("Name of the output space time dataset");
- break;
- case G_OPT_STRDS_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,strds,strds";
- Opt->description = _("Name of the input space time raster dataset");
- break;
- case G_OPT_STRDS_INPUTS:
- Opt->key = "inputs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,strds,strds";
- Opt->description = _("Name of the input space time raster datasets");
- break;
- case G_OPT_STRDS_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,strds,strds";
- Opt->description = _("Name of the output space time raster dataset");
- break;
- case G_OPT_STRDS_OUTPUTS:
- Opt->key = "outputs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "new,strds,strds";
- Opt->description = _("Name of the output space time raster datasets");
- break;
- case G_OPT_STVDS_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,stvds,stvds";
- Opt->description = _("Name of the input space time vector dataset");
- break;
- case G_OPT_STVDS_INPUTS:
- Opt->key = "inputs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,stvds,stvds";
- Opt->description = _("Name of the input space time vector datasets");
- break;
- case G_OPT_STVDS_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,stvds,stvds";
- Opt->description = _("Name of the output space time vector dataset");
- break;
- case G_OPT_STR3DS_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,str3ds,str3ds";
- Opt->description = _("Name of the input space time raster3d dataset");
- break;
- case G_OPT_STR3DS_INPUTS:
- Opt->key = "inputs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,str3ds,str3ds";
- Opt->description = _("Name of the input space time raster3d datasets");
- break;
- case G_OPT_STR3DS_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,str3ds,str3ds";
- Opt->description = _("Name of the output space time raster3d dataset");
- break;
- case G_OPT_STDS_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = "strds";
- Opt->options = "strds,stvds,str3ds";
- Opt->description = _("Type of the input space time dataset");
- break;
- case G_OPT_MAP_INPUT:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,map,map";
- Opt->description = _("Name of the input map");
- break;
- case G_OPT_MAP_INPUTS:
- Opt->key = "maps";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,map,map";
- Opt->description = _("Name of the input maps");
- break;
- case G_OPT_MAP_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = "raster";
- Opt->options = "raster,vector,raster_3d";
- Opt->description = _("Type of the input map");
- break;
- case G_OPT_T_TYPE:
- Opt->key = "temporaltype";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = "absolute";
- Opt->options = "absolute,relative";
- Opt->description = _("The temporal type of the space time dataset");
- break;
- case G_OPT_T_WHERE:
- Opt->key = "where";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "sql_query";
- Opt->required = NO;
- Opt->label = _("WHERE conditions of SQL statement without 'where' keyword used in the temporal GIS framework");
- Opt->description = _("Example: start_time > '2001-01-01 12:30:00'");
- break;
- case G_OPT_T_SAMPLE:
- Opt->key = "sampling";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->answer = "start";
- Opt->options = "start,during,overlap,contain,equal,follows,precedes";
- Opt->description = _("The method to be used for sampling the input dataset");
- break;
- }
-
- return Opt;
- }
- /*!
- \brief Create standardised Flag structure.
-
- This function will create a standardised Flag structure defined by
- parameter <i>flag</i>. A list of valid parameters below. It
- allocates memory for the Flag structure and returns a pointer to
- this memory.
-
- If an invalid parameter was specified a empty Flag structure will be
- returned (not NULL).
- - G_FLG_V_TABLE (do not create attribute table)
- - G_FLG_V_TOPO (do not build topology)
- \param flag type of Flag struct to create specified by STD_FLG enum.
- \return pointer to an Flag struct
- */
- struct Flag *G_define_standard_flag(int flag)
- {
- struct Flag *Flg;
- Flg = G_define_flag();
- switch (flag) {
- case G_FLG_V_TABLE:
- Flg->key = 't';
- Flg->description = _("Do not create attribute table");
- break;
- case G_FLG_V_TOPO:
- Flg->key = 'b';
- Flg->label = _("Do not build topology");
- Flg->description = _("Advantageous when handling a large number of points");
- break;
- }
-
- return Flg;
- }
|