parser_standard_options.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811
  1. /*!
  2. \file lib/gis/parser_standard_options.c
  3. \brief GIS Library - Argument parsing functions (standard options)
  4. (C) 2001-2011 by the GRASS Development Team
  5. This program is free software under the GNU General Public License
  6. (>=v2). Read the file COPYING that comes with GRASS for details.
  7. \author Original author CERL
  8. \author Soeren Gebbert added Dec. 2009 WPS process_description document
  9. \author Luca Delucchi added Aug 2011 G_OPT_M_DIR
  10. */
  11. #include <grass/gis.h>
  12. #include <grass/glocale.h>
  13. #include "parser_local_proto.h"
  14. /*!
  15. \brief Create standardised Option structure.
  16. This function will create a standardised Option structure defined by
  17. parameter <i>opt</i>. A list of valid parameters bellow. It
  18. allocates memory for the Option structure and returns a pointer to
  19. this memory.
  20. If an invalid parameter was specified a empty Option structure will
  21. be returned (not NULL).
  22. - database:
  23. - G_OPT_DB_WHERE
  24. - G_OPT_DB_TABLE
  25. - G_OPT_DB_DRIVER
  26. - G_OPT_DB_DATABASE
  27. - G_OPT_DB_SCHEMA
  28. - G_OPT_DB_COLUMN
  29. - G_OPT_DB_COLUMNS
  30. - G_OPT_DB_KEYCOLUMN
  31. - imagery:
  32. - G_OPT_I_GROUP
  33. - G_OPT_I_SUBGROUP
  34. - raster:
  35. - G_OPT_R_INPUT
  36. - G_OPT_R_INPUTS
  37. - G_OPT_R_OUTPUT
  38. - G_OPT_R_MAP
  39. - G_OPT_R_MAPS
  40. - G_OPT_R_BASE
  41. - G_OPT_R_COVER
  42. - G_OPT_R_ELEV
  43. - G_OPT_R_ELEVS
  44. - raster3d:
  45. - G_OPT_R3_INPUT
  46. - G_OPT_R3_INPUTS
  47. - G_OPT_R3_OUTPUT
  48. - G_OPT_R3_MAP
  49. - G_OPT_R3_MAPS
  50. - vector:
  51. - G_OPT_V_INPUT
  52. - G_OPT_V_INPUTS
  53. - G_OPT_V_OUTPUT
  54. - G_OPT_V_MAP
  55. - G_OPT_V_MAPS
  56. - G_OPT_V_TYPE
  57. - G_OPT_V_FIELD
  58. - G_OPT_V_FIELD_ALL
  59. - G_OPT_V_CAT
  60. - G_OPT_V_CATS
  61. - G_OPT_V_ID
  62. - G_OPT_V_IDS
  63. - files
  64. - G_OPT_F_INPUT
  65. - G_OPT_F_OUTPUT
  66. - G_OPT_F_SEP
  67. - colors
  68. - G_OPT_C_FG
  69. - G_OPT_C_BG
  70. - misc
  71. - G_OPT_M_UNITS
  72. - G_OPT_M_DATATYPE
  73. - G_OPT_M_MAPSET
  74. - G_OPT_M_COORDS
  75. - G_OPT_M_COLR
  76. - G_OPT_M_DIR
  77. - temporal GIS framework
  78. - G_OPT_STDS_INPUT
  79. - G_OPT_STDS_INPUTS
  80. - G_OPT_STDS_OUTPUT
  81. - G_OPT_STRDS_INPUT
  82. - G_OPT_STRDS_INPUTS
  83. - G_OPT_STRDS_OUTPUT
  84. - G_OPT_STR3DS_INPUT
  85. - G_OPT_STR3DS_INPUTS
  86. - G_OPT_STR3DS_OUTPUT
  87. - G_OPT_STVDS_INPUT
  88. - G_OPT_STVDS_INPUTS
  89. - G_OPT_STVDS_OUTPUT
  90. - G_OPT_MAP_INPUT
  91. - G_OPT_MAP_INPUTS
  92. - G_OPT_STDS_TYPE
  93. - G_OPT_MAP_TYPE
  94. - G_OPT_T_TYPE
  95. - G_OPT_T_WHERE
  96. \param opt type of Option struct to create
  97. \return pointer to an Option struct
  98. */
  99. struct Option *G_define_standard_option(int opt)
  100. {
  101. struct Option *Opt;
  102. Opt = G_define_option();
  103. switch (opt) {
  104. case G_OPT_DB_WHERE:
  105. Opt->key = "where";
  106. Opt->type = TYPE_STRING;
  107. Opt->key_desc = "sql_query";
  108. Opt->required = NO;
  109. Opt->label = _("WHERE conditions of SQL statement without 'where' keyword");
  110. Opt->description = _("Example: income < 1000 and inhab >= 10000");
  111. break;
  112. case G_OPT_DB_TABLE:
  113. Opt->key = "table";
  114. Opt->type = TYPE_STRING;
  115. Opt->key_desc = "name";
  116. Opt->required = NO;
  117. Opt->multiple = NO;
  118. Opt->description = _("Name of attribute table");
  119. Opt->gisprompt = "old,dbtable,dbtable";
  120. break;
  121. case G_OPT_DB_DRIVER:
  122. Opt->key = "driver";
  123. Opt->type = TYPE_STRING;
  124. Opt->key_desc = "name";
  125. Opt->required = NO;
  126. Opt->multiple = NO;
  127. Opt->description = _("Name of database driver");
  128. Opt->gisprompt = "old,dbdriver,dbdriver";
  129. break;
  130. case G_OPT_DB_DATABASE:
  131. Opt->key = "database";
  132. Opt->type = TYPE_STRING;
  133. Opt->key_desc = "name";
  134. Opt->required = NO;
  135. Opt->multiple = NO;
  136. Opt->description = _("Name of database");
  137. Opt->gisprompt = "old,dbname,dbname";
  138. break;
  139. case G_OPT_DB_SCHEMA:
  140. Opt->key = "schema";
  141. Opt->type = TYPE_STRING;
  142. Opt->key_desc = "name";
  143. Opt->required = NO;
  144. Opt->multiple = NO;
  145. Opt->label = _("Database schema");
  146. Opt->description = _("Do not use this option if schemas "
  147. "are not supported by driver/database server");
  148. break;
  149. case G_OPT_DB_COLUMN:
  150. Opt->key = "column";
  151. Opt->type = TYPE_STRING;
  152. Opt->key_desc = "name";
  153. Opt->required = NO;
  154. Opt->multiple = NO;
  155. Opt->description = _("Name of attribute column");
  156. Opt->gisprompt = "old,dbcolumn,dbcolumn";
  157. break;
  158. case G_OPT_DB_COLUMNS:
  159. Opt->key = "columns";
  160. Opt->type = TYPE_STRING;
  161. Opt->key_desc = "name";
  162. Opt->required = NO;
  163. Opt->multiple = YES;
  164. Opt->description = _("Name of attribute column(s)");
  165. Opt->gisprompt = "old,dbcolumn,dbcolumn";
  166. break;
  167. case G_OPT_DB_KEYCOLUMN:
  168. Opt->key = "key";
  169. Opt->type = TYPE_STRING;
  170. Opt->key_desc = "name";
  171. Opt->required = NO;
  172. Opt->multiple = NO;
  173. Opt->description = _("Name of key column");
  174. Opt->description = _("Must refer to an integer column");
  175. /* Opt->gisprompt = "old,dbcolumn,dbcolumn"; */
  176. Opt->answer = GV_KEY_COLUMN;
  177. break;
  178. /* imagery group */
  179. case G_OPT_I_GROUP:
  180. Opt->key = "group";
  181. Opt->type = TYPE_STRING;
  182. Opt->key_desc = "name";
  183. Opt->required = YES;
  184. Opt->gisprompt = "old,group,group";
  185. Opt->description = _("Name of input imagery group");
  186. break;
  187. case G_OPT_I_SUBGROUP:
  188. Opt->key = "subgroup";
  189. Opt->type = TYPE_STRING;
  190. Opt->key_desc = "name";
  191. Opt->required = YES;
  192. Opt->gisprompt = "old,subgroup,subgroup";
  193. Opt->description = _("Name of input imagery subgroup");
  194. break;
  195. /* raster maps */
  196. case G_OPT_R_INPUT:
  197. Opt->key = "input";
  198. Opt->type = TYPE_STRING;
  199. Opt->key_desc = "name";
  200. Opt->required = YES;
  201. Opt->gisprompt = "old,cell,raster";
  202. Opt->description = _("Name of input raster map");
  203. break;
  204. case G_OPT_R_INPUTS:
  205. Opt->key = "input";
  206. Opt->type = TYPE_STRING;
  207. Opt->key_desc = "name";
  208. Opt->required = YES;
  209. Opt->multiple = YES;
  210. Opt->gisprompt = "old,cell,raster";
  211. Opt->description = _("Name of input raster map(s)");
  212. break;
  213. case G_OPT_R_OUTPUT:
  214. Opt->key = "output";
  215. Opt->type = TYPE_STRING;
  216. Opt->key_desc = "name";
  217. Opt->required = YES;
  218. Opt->gisprompt = "new,cell,raster";
  219. Opt->description = _("Name for output raster map");
  220. break;
  221. case G_OPT_R_MAP:
  222. Opt->key = "map";
  223. Opt->type = TYPE_STRING;
  224. Opt->key_desc = "name";
  225. Opt->required = YES;
  226. Opt->gisprompt = "old,cell,raster";
  227. Opt->description = _("Name of raster map");
  228. break;
  229. case G_OPT_R_MAPS:
  230. Opt->key = "map";
  231. Opt->type = TYPE_STRING;
  232. Opt->key_desc = "name";
  233. Opt->required = YES;
  234. Opt->multiple = YES;
  235. Opt->gisprompt = "old,cell,raster";
  236. Opt->description = _("Name of raster map(s)");
  237. break;
  238. case G_OPT_R_BASE:
  239. Opt->key = "base";
  240. Opt->type = TYPE_STRING;
  241. Opt->key_desc = "name";
  242. Opt->required = YES;
  243. Opt->gisprompt = "old,cell,raster";
  244. Opt->description = _("Name of base raster map");
  245. break;
  246. case G_OPT_R_COVER:
  247. Opt->key = "cover";
  248. Opt->type = TYPE_STRING;
  249. Opt->key_desc = "name";
  250. Opt->required = YES;
  251. Opt->gisprompt = "old,cell,raster";
  252. Opt->description = _("Name of cover raster map");
  253. break;
  254. case G_OPT_R_ELEV:
  255. Opt->key = "elevation";
  256. Opt->type = TYPE_STRING;
  257. Opt->key_desc = "name";
  258. Opt->required = YES;
  259. Opt->gisprompt = "old,cell,raster";
  260. Opt->description = _("Name of input elevation raster map");
  261. break;
  262. case G_OPT_R_ELEVS:
  263. Opt->key = "elevation";
  264. Opt->type = TYPE_STRING;
  265. Opt->key_desc = "name";
  266. Opt->required = YES;
  267. Opt->multiple = YES;
  268. Opt->gisprompt = "old,cell,raster";
  269. Opt->description = _("Name of input elevation raster map(s)");
  270. break;
  271. /*g3d maps */
  272. case G_OPT_R3_INPUT:
  273. Opt->key = "input";
  274. Opt->type = TYPE_STRING;
  275. Opt->key_desc = "name";
  276. Opt->required = YES;
  277. Opt->gisprompt = "old,grid3,3d-raster";
  278. Opt->description = _("Name of input 3D raster map");
  279. break;
  280. case G_OPT_R3_INPUTS:
  281. Opt->key = "input";
  282. Opt->type = TYPE_STRING;
  283. Opt->key_desc = "name";
  284. Opt->required = YES;
  285. Opt->multiple = YES;
  286. Opt->gisprompt = "old,grid3,3d-raster";
  287. Opt->description = _("Name of input 3D raster map(s)");
  288. break;
  289. case G_OPT_R3_OUTPUT:
  290. Opt->key = "output";
  291. Opt->type = TYPE_STRING;
  292. Opt->key_desc = "name";
  293. Opt->required = YES;
  294. Opt->gisprompt = "new,grid3,3d-raster";
  295. Opt->description = _("Name for output 3D raster map");
  296. break;
  297. case G_OPT_R3_MAP:
  298. Opt->key = "map";
  299. Opt->type = TYPE_STRING;
  300. Opt->key_desc = "name";
  301. Opt->required = YES;
  302. Opt->gisprompt = "old,grid3,3d-raster";
  303. Opt->description = _("Name of 3D raster map");
  304. break;
  305. case G_OPT_R3_MAPS:
  306. Opt->key = "map";
  307. Opt->type = TYPE_STRING;
  308. Opt->key_desc = "name";
  309. Opt->required = YES;
  310. Opt->multiple = YES;
  311. Opt->gisprompt = "old,grid3,3d-raster";
  312. Opt->description = _("Name of 3D raster map(s)");
  313. break;
  314. case G_OPT_R3_TYPE:
  315. Opt->key = "type";
  316. Opt->type = TYPE_STRING;
  317. Opt->required = NO;
  318. Opt->multiple = NO;
  319. Opt->answer = "default";
  320. Opt->options = "default,double,float";
  321. Opt->description = _("Data type used in the output raster3d map");
  322. break;
  323. case G_OPT_R3_PRECISION:
  324. Opt->key = "precision";
  325. Opt->type = TYPE_STRING;
  326. Opt->required = NO;
  327. Opt->multiple = NO;
  328. Opt->answer = "default";
  329. Opt->description =
  330. _("Number of digits used as mantissa in the internal map storage, 0 -23 for float, 0 - 52 for double, max or default");
  331. break;
  332. case G_OPT_R3_COMPRESSION:
  333. Opt->key = "compression";
  334. Opt->type = TYPE_STRING;
  335. Opt->required = NO;
  336. Opt->multiple = NO;
  337. Opt->answer = "default";
  338. Opt->options = "default,rle,none";
  339. Opt->description =
  340. _("The compression method used in the output raster3d map");
  341. break;
  342. case G_OPT_R3_TILE_DIMENSION:
  343. Opt->key = "tiledimension";
  344. Opt->type = TYPE_STRING;
  345. Opt->required = NO;
  346. Opt->multiple = NO;
  347. Opt->key_desc = "XxYxZ";
  348. Opt->answer = "default";
  349. Opt->description =
  350. _("The dimensions of the tiles used in the output raster3d map (XxYxZ or default: 16x16x8)");
  351. break;
  352. /*vector maps */
  353. case G_OPT_V_INPUT:
  354. Opt->key = "input";
  355. Opt->type = TYPE_STRING;
  356. Opt->key_desc = "name";
  357. Opt->required = YES;
  358. Opt->gisprompt = "old,vector,vector";
  359. Opt->label = _("Name of input vector map");
  360. Opt->description = _("Or data source for direct OGR access");
  361. break;
  362. case G_OPT_V_INPUTS:
  363. Opt->key = "input";
  364. Opt->type = TYPE_STRING;
  365. Opt->key_desc = "name";
  366. Opt->required = YES;
  367. Opt->multiple = YES;
  368. Opt->gisprompt = "old,vector,vector";
  369. Opt->label = _("Name of input vector map(s)");
  370. Opt->description = _("Or data source(s) for direct OGR access");
  371. break;
  372. case G_OPT_V_OUTPUT:
  373. Opt->key = "output";
  374. Opt->type = TYPE_STRING;
  375. Opt->key_desc = "name";
  376. Opt->required = YES;
  377. Opt->gisprompt = "new,vector,vector";
  378. Opt->description = _("Name for output vector map");
  379. break;
  380. case G_OPT_V_MAP:
  381. Opt->key = "map";
  382. Opt->type = TYPE_STRING;
  383. Opt->key_desc = "name";
  384. Opt->required = YES;
  385. Opt->gisprompt = "old,vector,vector";
  386. Opt->label = _("Name of vector map");
  387. Opt->description = _("Or data source for direct OGR access");
  388. break;
  389. case G_OPT_V_MAPS:
  390. Opt->key = "map";
  391. Opt->type = TYPE_STRING;
  392. Opt->key_desc = "name";
  393. Opt->required = YES;
  394. Opt->multiple = YES;
  395. Opt->gisprompt = "old,vector,vector";
  396. Opt->description = _("Name of vector map(s)");
  397. break;
  398. case G_OPT_V_TYPE:
  399. Opt->key = "type";
  400. Opt->type = TYPE_STRING;
  401. Opt->required = NO;
  402. Opt->multiple = YES;
  403. Opt->answer = "point,line,boundary,centroid,area";
  404. Opt->options = "point,line,boundary,centroid,area";
  405. Opt->description = _("Feature type");
  406. break;
  407. case G_OPT_V3_TYPE:
  408. Opt->key = "type";
  409. Opt->type = TYPE_STRING;
  410. Opt->required = NO;
  411. Opt->multiple = YES;
  412. Opt->answer = "point,line,boundary,centroid,area,face,kernel";
  413. Opt->options = "point,line,boundary,centroid,area,face,kernel";
  414. Opt->description = _("Feature type");
  415. break;
  416. case G_OPT_V_FIELD:
  417. Opt->key = "layer";
  418. Opt->type = TYPE_STRING;
  419. Opt->required = YES;
  420. Opt->answer = "1";
  421. Opt->label = _("Layer number or name");
  422. Opt->description =
  423. _("A single vector map can be connected to multiple database "
  424. "tables. This number determines which table to use. "
  425. "When used with direct OGR access this is the layer name.");
  426. Opt->gisprompt = "old,layer,layer";
  427. break;
  428. case G_OPT_V_FIELD_ALL:
  429. Opt->key = "layer";
  430. Opt->type = TYPE_STRING;
  431. Opt->required = YES;
  432. Opt->answer = "-1";
  433. Opt->label = _("Layer number or name ('-1' for all layers)");
  434. Opt->description =
  435. _("A single vector map can be connected to multiple database "
  436. "tables. This number determines which table to use. "
  437. "When used with direct OGR access this is the layer name.");
  438. Opt->gisprompt = "old,layer,layer_all";
  439. break;
  440. case G_OPT_V_CAT:
  441. Opt->key = "cat";
  442. Opt->type = TYPE_INTEGER;
  443. Opt->required = NO;
  444. Opt->description = _("Category value");
  445. break;
  446. case G_OPT_V_CATS:
  447. Opt->key = "cats";
  448. Opt->type = TYPE_STRING;
  449. Opt->key_desc = "range";
  450. Opt->required = NO;
  451. Opt->label = _("Category values");
  452. Opt->description = _("Example: 1,3,7-9,13");
  453. break;
  454. case G_OPT_V_ID:
  455. Opt->key = "id";
  456. Opt->type = TYPE_INTEGER;
  457. Opt->required = NO;
  458. Opt->description = _("Feature id");
  459. break;
  460. case G_OPT_V_IDS:
  461. Opt->key = "ids";
  462. Opt->type = TYPE_STRING;
  463. Opt->key_desc = "range";
  464. Opt->required = NO;
  465. Opt->label = _("Feature ids");
  466. Opt->description = _("Example: 1,3,7-9,13");
  467. break;
  468. /* files */
  469. case G_OPT_F_INPUT:
  470. Opt->key = "input";
  471. Opt->type = TYPE_STRING;
  472. Opt->key_desc = "name";
  473. Opt->required = YES;
  474. Opt->gisprompt = "old,file,input";
  475. Opt->description = _("Name of input file");
  476. break;
  477. case G_OPT_F_OUTPUT:
  478. Opt->key = "output";
  479. Opt->type = TYPE_STRING;
  480. Opt->key_desc = "name";
  481. Opt->required = YES;
  482. Opt->gisprompt = "new,file,output";
  483. Opt->description = _("Name for output file");
  484. break;
  485. case G_OPT_F_SEP:
  486. Opt->key = "fs";
  487. Opt->type = TYPE_STRING;
  488. Opt->key_desc = "character";
  489. Opt->required = NO;
  490. Opt->answer = "|";
  491. Opt->label = _("Field separator");
  492. Opt->description = _("Special characters: newline, space, comma, tab");
  493. break;
  494. /* colors */
  495. case G_OPT_C_FG:
  496. Opt->key = "color";
  497. Opt->type = TYPE_STRING;
  498. Opt->key_desc = "name";
  499. Opt->required = NO;
  500. Opt->answer = DEFAULT_FG_COLOR;
  501. Opt->gisprompt = "old,color,color";
  502. Opt->label = _("Color");
  503. Opt->description = _("Either a standard color name or R:G:B triplet");
  504. break;
  505. case G_OPT_C_BG:
  506. Opt->key = "bgcolor";
  507. Opt->type = TYPE_STRING;
  508. Opt->key_desc = "name";
  509. Opt->required = NO;
  510. Opt->answer = DEFAULT_BG_COLOR;
  511. Opt->gisprompt = "old,color,color_none";
  512. Opt->label = _("Background color");
  513. Opt->description =
  514. _("Either a standard GRASS color, R:G:B triplet, or \"none\"");
  515. break;
  516. /* misc */
  517. case G_OPT_M_DIR:
  518. Opt->key = "input";
  519. Opt->type = TYPE_STRING;
  520. Opt->key_desc = "name";
  521. Opt->required = YES;
  522. Opt->gisprompt = "old,dir,input";
  523. Opt->description = _("Name to input directory");
  524. break;
  525. case G_OPT_M_UNITS:
  526. Opt->key = "units";
  527. Opt->type = TYPE_STRING;
  528. Opt->required = NO;
  529. Opt->multiple = NO;
  530. Opt->options =
  531. "miles,feet,meters,kilometers,acres,hectares";
  532. Opt->description = _("Units");
  533. break;
  534. case G_OPT_M_DATATYPE:
  535. Opt->key = "type";
  536. Opt->key_desc = "datatype";
  537. Opt->type = TYPE_STRING;
  538. Opt->required = YES;
  539. Opt->multiple = YES;
  540. Opt->description = _("Data type(s)");
  541. break;
  542. case G_OPT_M_MAPSET:
  543. Opt->key = "mapset";
  544. Opt->type = TYPE_STRING;
  545. Opt->required = NO;
  546. Opt->multiple = NO;
  547. Opt->key_desc = "name";
  548. Opt->gisprompt = "old,mapset,mapset";
  549. Opt->label = _("Name of mapset (default: current search path)");
  550. Opt->description = _("'.' for current mapset");
  551. break;
  552. case G_OPT_M_COORDS:
  553. Opt->key = "coordinates";
  554. Opt->type = TYPE_DOUBLE;
  555. Opt->required = NO;
  556. Opt->multiple = NO;
  557. Opt->key_desc = "east,north";
  558. Opt->gisprompt = "old,coords,coords";
  559. Opt->description = _("Coordinates");
  560. break;
  561. case G_OPT_M_COLR:
  562. Opt->key = "color";
  563. Opt->key_desc = "style";
  564. Opt->type = TYPE_STRING;
  565. Opt->required = NO;
  566. Opt->options = G_color_rules_options();
  567. Opt->description = _("Name of color table");
  568. Opt->descriptions = G_color_rules_descriptions();
  569. break;
  570. /* Spatio-temporal modules of the temporal GIS framework */
  571. case G_OPT_STDS_INPUT:
  572. Opt->key = "input";
  573. Opt->type = TYPE_STRING;
  574. Opt->key_desc = "name";
  575. Opt->required = YES;
  576. Opt->gisprompt = "old,stds,stds";
  577. Opt->description = _("Name of the input space time dataset");
  578. break;
  579. case G_OPT_STDS_INPUTS:
  580. Opt->key = "inputs";
  581. Opt->type = TYPE_STRING;
  582. Opt->key_desc = "name";
  583. Opt->required = YES;
  584. Opt->multiple = YES;
  585. Opt->gisprompt = "old,stds,stds";
  586. Opt->description = _("Name of the input space time datasets");
  587. break;
  588. case G_OPT_STDS_OUTPUT:
  589. Opt->key = "output";
  590. Opt->type = TYPE_STRING;
  591. Opt->key_desc = "name";
  592. Opt->required = YES;
  593. Opt->gisprompt = "new,stds,stds";
  594. Opt->description = _("Name of the output space time dataset");
  595. break;
  596. case G_OPT_STRDS_INPUT:
  597. Opt->key = "input";
  598. Opt->type = TYPE_STRING;
  599. Opt->key_desc = "name";
  600. Opt->required = YES;
  601. Opt->gisprompt = "old,strds,strds";
  602. Opt->description = _("Name of the input space time raster dataset");
  603. break;
  604. case G_OPT_STRDS_INPUTS:
  605. Opt->key = "inputs";
  606. Opt->type = TYPE_STRING;
  607. Opt->key_desc = "name";
  608. Opt->required = YES;
  609. Opt->multiple = YES;
  610. Opt->gisprompt = "old,strds,strds";
  611. Opt->description = _("Name of the input space time raster datasets");
  612. break;
  613. case G_OPT_STRDS_OUTPUT:
  614. Opt->key = "output";
  615. Opt->type = TYPE_STRING;
  616. Opt->key_desc = "name";
  617. Opt->required = YES;
  618. Opt->gisprompt = "new,strds,strds";
  619. Opt->description = _("Name of the output space time raster dataset");
  620. break;
  621. case G_OPT_STVDS_INPUT:
  622. Opt->key = "input";
  623. Opt->type = TYPE_STRING;
  624. Opt->key_desc = "name";
  625. Opt->required = YES;
  626. Opt->gisprompt = "old,stvds,stvds";
  627. Opt->description = _("Name of the input space time vector dataset");
  628. break;
  629. case G_OPT_STVDS_INPUTS:
  630. Opt->key = "inputs";
  631. Opt->type = TYPE_STRING;
  632. Opt->key_desc = "name";
  633. Opt->required = YES;
  634. Opt->multiple = YES;
  635. Opt->gisprompt = "old,stvds,stvds";
  636. Opt->description = _("Name of the input space time vector datasets");
  637. break;
  638. case G_OPT_STVDS_OUTPUT:
  639. Opt->key = "output";
  640. Opt->type = TYPE_STRING;
  641. Opt->key_desc = "name";
  642. Opt->required = YES;
  643. Opt->gisprompt = "new,stvds,stvds";
  644. Opt->description = _("Name of the output space time vector dataset");
  645. break;
  646. case G_OPT_STR3DS_INPUT:
  647. Opt->key = "input";
  648. Opt->type = TYPE_STRING;
  649. Opt->key_desc = "name";
  650. Opt->required = YES;
  651. Opt->gisprompt = "old,str3ds,str3ds";
  652. Opt->description = _("Name of the input space time raster3d dataset");
  653. break;
  654. case G_OPT_STR3DS_INPUTS:
  655. Opt->key = "inputs";
  656. Opt->type = TYPE_STRING;
  657. Opt->key_desc = "name";
  658. Opt->required = YES;
  659. Opt->multiple = YES;
  660. Opt->gisprompt = "old,str3ds,str3ds";
  661. Opt->description = _("Name of the input space time raster3d datasets");
  662. break;
  663. case G_OPT_STR3DS_OUTPUT:
  664. Opt->key = "output";
  665. Opt->type = TYPE_STRING;
  666. Opt->key_desc = "name";
  667. Opt->required = YES;
  668. Opt->gisprompt = "new,str3ds,str3ds";
  669. Opt->description = _("Name of the output space time raster3d dataset");
  670. break;
  671. case G_OPT_STDS_TYPE:
  672. Opt->key = "type";
  673. Opt->type = TYPE_STRING;
  674. Opt->key_desc = "name";
  675. Opt->required = NO;
  676. Opt->answer = "strds";
  677. Opt->options = "strds,stvds,str3ds";
  678. Opt->description = _("Type of the input space time dataset");
  679. break;
  680. case G_OPT_MAP_INPUT:
  681. Opt->key = "map";
  682. Opt->type = TYPE_STRING;
  683. Opt->key_desc = "name";
  684. Opt->required = YES;
  685. Opt->gisprompt = "old,map,map";
  686. Opt->description = _("Name of the input map");
  687. break;
  688. case G_OPT_MAP_INPUTS:
  689. Opt->key = "maps";
  690. Opt->type = TYPE_STRING;
  691. Opt->key_desc = "name";
  692. Opt->required = YES;
  693. Opt->multiple = YES;
  694. Opt->gisprompt = "old,map,map";
  695. Opt->description = _("Name of the input maps");
  696. break;
  697. case G_OPT_MAP_TYPE:
  698. Opt->key = "type";
  699. Opt->type = TYPE_STRING;
  700. Opt->key_desc = "name";
  701. Opt->required = NO;
  702. Opt->answer = "rast";
  703. Opt->options = "rast,vect,rast3d";
  704. Opt->description = _("Type of the input map");
  705. break;
  706. case G_OPT_T_TYPE:
  707. Opt->key = "temporaltype";
  708. Opt->type = TYPE_STRING;
  709. Opt->key_desc = "name";
  710. Opt->required = NO;
  711. Opt->answer = "absolute";
  712. Opt->options = "absolute,relative";
  713. Opt->description = _("The temporal type of the space time dataset");
  714. break;
  715. case G_OPT_T_WHERE:
  716. Opt->key = "where";
  717. Opt->type = TYPE_STRING;
  718. Opt->key_desc = "sql_query";
  719. Opt->required = NO;
  720. Opt->label = _("WHERE conditions of SQL statement without 'where' keyword used in the temporal GIS framework");
  721. Opt->description = _("Example: start_time > '2001-01-01 12:30:00'");
  722. break;
  723. case G_OPT_T_SAMPLE:
  724. Opt->key = "sampling";
  725. Opt->type = TYPE_STRING;
  726. Opt->key_desc = "name";
  727. Opt->required = NO;
  728. Opt->multiple = YES;
  729. Opt->answer = "start";
  730. Opt->options = "start,during,overlap,contain,equal";
  731. Opt->description = _("The method to be used for sampling the input dataset");
  732. break;
  733. }
  734. return Opt;
  735. }
  736. /*!
  737. \brief Create standardised Flag structure.
  738. This function will create a standardised Flag structure defined by
  739. parameter <i>flag</i>. A list of valid parameters bellow. It
  740. allocates memory for the Flag structure and returns a pointer to
  741. this memory.
  742. If an invalid parameter was specified a empty Flag structure will be
  743. returned (not NULL).
  744. - G_FLG_V_TABLE (do not create attribute table)
  745. - G_FLG_V_TOPO (do not build topology)
  746. \param flag type of Flag struct to create
  747. \return pointer to an Flag struct
  748. */
  749. struct Flag *G_define_standard_flag(int flag)
  750. {
  751. struct Flag *Flg;
  752. Flg = G_define_flag();
  753. switch (flag) {
  754. case G_FLG_V_TABLE:
  755. Flg->key = 't';
  756. Flg->description = _("Do not create attribute table");
  757. break;
  758. case G_FLG_V_TOPO:
  759. Flg->key = 'b';
  760. Flg->description = _("Do not build topology");
  761. break;
  762. }
  763. return Flg;
  764. }