GRASS GIS 7 Programmer's Manual  7.9.dev(2020)-547ded6c0
gis.h File Reference
#include <stdio.h>
#include <stdarg.h>
#include <grass/config.h>
#include <grass/datetime.h>
#include <grass/version.h>
#include <grass/defs/gis.h>
Include dependency graph for gis.h:

Go to the source code of this file.

Data Structures

struct  Cell_head
 2D/3D raster map header (used also for region) More...
 
struct  G_3dview
 
struct  Key_Value
 
struct  Option
 Structure that stores option information. More...
 
struct  Flag
 Structure that stores flag info. More...
 
struct  GModule
 Structure that stores module info. More...
 
struct  TimeStamp
 
struct  Counter
 
struct  Popen
 
struct  _Color_Value_
 
struct  _Color_Rule_
 
struct  _Color_Info_
 
struct  Colors
 
struct  ilist
 List of integers. More...
 

Macros

#define __attribute__(x)
 
#define GIS_H_VERSION   GRASS_HEADERS_VERSION
 
#define GIS_H_DATE   GRASS_HEADERS_DATE
 
#define G_gisinit(pgm)   G__gisinit(GIS_H_VERSION, (pgm))
 
#define G_no_gisinit()   G__no_gisinit(GIS_H_VERSION)
 
#define TRUE   1
 
#define FALSE   0
 
#define PRI_OFF_T   "ld"
 
#define NEWLINE   '\n'
 Cross-platform Newline Character. More...
 
#define HOST_NEWLINE   "\n"
 
#define WARN_UNUSED_RESULT
 Generate warning if function return value is unused. More...
 
#define U_UNDEFINED   -1
 List of units. More...
 
#define U_UNKNOWN   0
 
#define U_ACRES   1
 
#define U_HECTARES   2
 
#define U_KILOMETERS   3
 
#define U_METERS   4
 
#define U_MILES   5
 
#define U_FEET   6
 
#define U_RADIANS   7
 
#define U_DEGREES   8
 
#define U_USFEET   9
 
#define U_YEARS   DATETIME_YEAR
 
#define U_MONTHS   DATETIME_MONTH
 
#define U_DAYS   DATETIME_DAY
 
#define U_HOURS   DATETIME_HOUR
 
#define U_MINUTES   DATETIME_MINUTE
 
#define U_SECONDS   DATETIME_SECOND
 
#define PROJECTION_XY   0
 Projection code - XY coordinate system (unreferenced data) More...
 
#define PROJECTION_UTM   1
 Projection code - UTM. More...
 
#define PROJECTION_SP   2
 Projection code - State Plane. More...
 
#define PROJECTION_LL   3
 Projection code - Latitude-Longitude. More...
 
#define PROJECTION_OTHER   99
 Projection code - other projection (other then noted above) More...
 
#define PROJECTION_FILE   "PROJ_INFO"
 
#define UNIT_FILE   "PROJ_UNITS"
 
#define EPSG_FILE   "PROJ_EPSG"
 
#define WKT_FILE   "PROJ_WKT"
 
#define SRID_FILE   "PROJ_SRID"
 
#define CONFIG_DIR   ".grass7"
 
#define M_PI   3.14159265358979323846 /* pi */
 
#define M_PI_2   1.57079632679489661923 /* pi/2 */
 
#define M_PI_4   0.78539816339744830962 /* pi/4 */
 
#define M_R2D   57.295779513082320877 /* 180/pi */
 
#define M_D2R   0.017453292519943295769 /* pi/180 */
 
#define GRASS_EPSILON   1.0e-15
 
#define G_VAR_GISRC   0
 
#define G_VAR_MAPSET   1
 
#define G_GISRC_MODE_FILE   0 /* files */
 
#define G_GISRC_MODE_MEMORY   1 /* memory only */
 
#define TYPE_INTEGER   1
 
#define TYPE_DOUBLE   2
 
#define TYPE_STRING   3
 
#define YES   1
 
#define NO   0
 
#define GNAME_MAX   256
 
#define GMAPSET_MAX   256
 
#define GPATH_MAX   4096
 
#define GBASENAME_SEP   "_"
 
#define serialize_int32_le(buf, x)
 
#define deserialize_int32_le(buf)
 
#define serialize_int32_be(buf, x)
 
#define deserialize_int32_be(buf)
 
#define GRASS_DIRSEP   '/'
 
#define HOST_DIRSEP   '/'
 
#define G_DEV_NULL   "/dev/null"
 
#define G_INFO_FORMAT_STANDARD   0 /* GRASS_MESSAGE_FORMAT=standard or not defined */
 
#define G_INFO_FORMAT_GUI   1 /* GRASS_MESSAGE_FORMAT=gui */
 
#define G_INFO_FORMAT_SILENT   2 /* GRASS_MESSAGE_FORMAT=silent */
 
#define G_INFO_FORMAT_PLAIN   3 /* GRASS_MESSAGE_FORMAT=plain */
 
#define G_ICON_CROSS   0
 
#define G_ICON_BOX   1
 
#define G_ICON_ARROW   2
 
#define DEFAULT_FG_COLOR   "black"
 
#define DEFAULT_BG_COLOR   "white"
 
#define DEFAULT_COLOR_TABLE   "viridis"
 
#define G_FATAL_EXIT   0
 
#define G_FATAL_PRINT   1
 
#define G_FATAL_RETURN   2
 
#define ENDIAN_LITTLE   0
 Endian check. More...
 
#define ENDIAN_BIG   1
 
#define ENDIAN_OTHER   2
 
#define GV_KEY_COLUMN   "cat"
 Name of default key column. More...
 

Typedefs

typedef int CELL
 
typedef double DCELL
 
typedef float FCELL
 
typedef grass_int64 LCELL
 

Enumerations

enum  STD_OPT {
  G_OPT_UNDEFINED, 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, G_OPT_I_GROUP, G_OPT_I_SUBGROUP,
  G_OPT_MEMORYMB, G_OPT_R_INPUT, G_OPT_R_INPUTS, G_OPT_R_OUTPUT,
  G_OPT_R_OUTPUTS, 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, G_OPT_R3_INPUT,
  G_OPT_R3_INPUTS, G_OPT_R3_OUTPUT, G_OPT_R3_MAP, G_OPT_R3_MAPS,
  G_OPT_R3_TYPE, G_OPT_R3_PRECISION, G_OPT_R3_TILE_DIMENSION, G_OPT_R3_COMPRESSION,
  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_V3_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, G_OPT_F_INPUT, G_OPT_F_BIN_INPUT, G_OPT_F_OUTPUT,
  G_OPT_F_SEP, G_OPT_C, G_OPT_CN, 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_DIR, G_OPT_M_REGION,
  G_OPT_M_NULL_VALUE, 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,
  G_OPT_T_SAMPLE
}
 Standard option identifiers (enum) More...
 
enum  STD_FLG { G_FLG_UNDEFINED, G_FLG_V_TABLE, G_FLG_V_TOPO }
 Standard flag identifiers (enum) More...
 
enum  rule_type {
  RULE_EXCLUSIVE, RULE_REQUIRED, RULE_REQUIRES, RULE_REQUIRES_ALL,
  RULE_EXCLUDES, RULE_COLLECTIVE
}
 
enum  {
  G_ELEMENT_RASTER = 1, G_ELEMENT_RASTER3D = 2, G_ELEMENT_VECTOR = 3, G_ELEMENT_ASCIIVECTOR = 4,
  G_ELEMENT_LABEL = 5, G_ELEMENT_REGION = 6, G_ELEMENT_GROUP = 7
}
 Element types identifiers (enum) More...
 

Macro Definition Documentation

◆ __attribute__

#define __attribute__ (   x)

Definition at line 36 of file gis.h.

◆ CONFIG_DIR

#define CONFIG_DIR   ".grass7"

Definition at line 126 of file gis.h.

Referenced by G_config_path().

◆ DEFAULT_BG_COLOR

#define DEFAULT_BG_COLOR   "white"

Definition at line 368 of file gis.h.

Referenced by D_setup(), D_setup2(), and D_setup_unity().

◆ DEFAULT_COLOR_TABLE

#define DEFAULT_COLOR_TABLE   "viridis"

Definition at line 369 of file gis.h.

◆ DEFAULT_FG_COLOR

#define DEFAULT_FG_COLOR   "black"

Definition at line 367 of file gis.h.

Referenced by G_define_standard_option(), and PNG_Graph_set().

◆ deserialize_int32_be

#define deserialize_int32_be (   buf)
Value:
(((buf)[0] << 24) | \
((buf)[1] << 16) | \
((buf)[2] << 8) | \
((buf)[3] << 0))

Definition at line 199 of file gis.h.

◆ deserialize_int32_le

#define deserialize_int32_le (   buf)
Value:
(((buf)[0] << 0) | \
((buf)[1] << 8) | \
((buf)[2] << 16) | \
((buf)[3] << 24))

Definition at line 185 of file gis.h.

◆ ENDIAN_BIG

#define ENDIAN_BIG   1

Definition at line 378 of file gis.h.

Referenced by dig__byte_order_out(), and dig_init_portable().

◆ ENDIAN_LITTLE

#define ENDIAN_LITTLE   0

Endian check.

Definition at line 377 of file gis.h.

Referenced by dig__byte_order_out().

◆ ENDIAN_OTHER

#define ENDIAN_OTHER   2

Definition at line 379 of file gis.h.

◆ EPSG_FILE

#define EPSG_FILE   "PROJ_EPSG"

Definition at line 119 of file gis.h.

Referenced by G_get_projepsg().

◆ FALSE

◆ G_DEV_NULL

#define G_DEV_NULL   "/dev/null"

Definition at line 211 of file gis.h.

◆ G_FATAL_EXIT

#define G_FATAL_EXIT   0

Definition at line 372 of file gis.h.

◆ G_FATAL_PRINT

#define G_FATAL_PRINT   1

Definition at line 373 of file gis.h.

◆ G_FATAL_RETURN

#define G_FATAL_RETURN   2

Definition at line 374 of file gis.h.

◆ G_gisinit

#define G_gisinit (   pgm)    G__gisinit(GIS_H_VERSION, (pgm))

Definition at line 51 of file gis.h.

Referenced by Cairo_Graph_set(), main(), PNG_Graph_set(), and PS_Graph_set().

◆ G_GISRC_MODE_FILE

#define G_GISRC_MODE_FILE   0 /* files */

Definition at line 153 of file gis.h.

◆ G_GISRC_MODE_MEMORY

#define G_GISRC_MODE_MEMORY   1 /* memory only */

Definition at line 154 of file gis.h.

◆ G_ICON_ARROW

#define G_ICON_ARROW   2

Definition at line 364 of file gis.h.

◆ G_ICON_BOX

#define G_ICON_BOX   1

Definition at line 363 of file gis.h.

◆ G_ICON_CROSS

#define G_ICON_CROSS   0

Definition at line 362 of file gis.h.

◆ G_INFO_FORMAT_GUI

#define G_INFO_FORMAT_GUI   1 /* GRASS_MESSAGE_FORMAT=gui */

Definition at line 357 of file gis.h.

◆ G_INFO_FORMAT_PLAIN

#define G_INFO_FORMAT_PLAIN   3 /* GRASS_MESSAGE_FORMAT=plain */

Definition at line 359 of file gis.h.

◆ G_INFO_FORMAT_SILENT

#define G_INFO_FORMAT_SILENT   2 /* GRASS_MESSAGE_FORMAT=silent */

Definition at line 358 of file gis.h.

◆ G_INFO_FORMAT_STANDARD

#define G_INFO_FORMAT_STANDARD   0 /* GRASS_MESSAGE_FORMAT=standard or not defined */

Definition at line 356 of file gis.h.

◆ G_no_gisinit

#define G_no_gisinit ( )    G__no_gisinit(GIS_H_VERSION)

Definition at line 52 of file gis.h.

◆ G_VAR_GISRC

#define G_VAR_GISRC   0

Definition at line 149 of file gis.h.

Referenced by G__read_env(), and G__write_env().

◆ G_VAR_MAPSET

◆ GBASENAME_SEP

#define GBASENAME_SEP   "_"

Definition at line 170 of file gis.h.

Referenced by G_get_basename_separator().

◆ GIS_H_DATE

#define GIS_H_DATE   GRASS_HEADERS_DATE

Definition at line 49 of file gis.h.

◆ GIS_H_VERSION

#define GIS_H_VERSION   GRASS_HEADERS_VERSION

Definition at line 45 of file gis.h.

◆ GMAPSET_MAX

◆ GNAME_MAX

◆ GPATH_MAX

#define GPATH_MAX   4096

Definition at line 167 of file gis.h.

Referenced by db_set_default_connection(), G_config_path(), G_get_available_mapsets(), G_get_projepsg(), G_get_projinfo(), G_get_projsrid(), G_get_projunits(), G_get_projwkt(), G_has_vector_timestamp(), G_make_mapset(), G_make_mapset_element(), G_make_mapset_element_tmp(), G_mapset_permissions(), G_mapset_permissions2(), G_myname(), G_read_datum_table(), G_read_ellipsoid_table(), G_read_vector_timestamp(), G_recursive_remove(), G_remove_vector_timestamp(), G_rename(), G_tempfile_pid(), G_write_projsrid(), G_write_projwkt(), G_write_vector_timestamp(), GPJ_get_datum_transform_by_name(), gsds_get_name(), gvl_file_get_name(), I_fopen_signature_file_new(), I_fopen_signature_file_old(), I_fopen_sigset_file_new(), I_fopen_sigset_file_old(), list_subgroups(), M_do_copy(), M_do_remove(), M_read_list(), parse_fontcap(), parse_fontcap_entry(), Rast3d_range_write(), Rast__check_fp_type(), Rast__close_null(), Rast_create_gdal_link(), Rast_map_is_fp(), Rast_map_type(), Rast_put_reclass(), read_datum_table(), read_ellipsoid_table(), V1_close_nat(), V1_open_new_nat(), V1_open_old_nat(), V2_close_pg(), Vect__delete(), Vect__get_element_path(), Vect__get_path(), Vect__open_old(), Vect__read_head(), Vect__write_head(), Vect_cidx_open(), Vect_cidx_save(), Vect_coor_info(), Vect_copy(), Vect_hist_command(), Vect_open_fidx(), Vect_open_topo(), Vect_remove_colors(), Vect_save_fidx(), Vect_save_frmt(), Vect_save_sidx(), Vect_save_topo(), and Vect_write_dblinks().

◆ GRASS_DIRSEP

#define GRASS_DIRSEP   '/'

Definition at line 205 of file gis.h.

Referenced by G_convert_dirseps_from_host(), and G_convert_dirseps_to_host().

◆ GRASS_EPSILON

#define GRASS_EPSILON   1.0e-15

Definition at line 146 of file gis.h.

◆ GV_KEY_COLUMN

#define GV_KEY_COLUMN   "cat"

Name of default key column.

Definition at line 385 of file gis.h.

Referenced by G_define_standard_option().

◆ HOST_DIRSEP

◆ HOST_NEWLINE

#define HOST_NEWLINE   "\n"

Definition at line 74 of file gis.h.

Referenced by Vect_write_ascii_head().

◆ M_D2R

#define M_D2R   0.017453292519943295769 /* pi/180 */

Definition at line 143 of file gis.h.

◆ M_PI

#define M_PI   3.14159265358979323846 /* pi */

Definition at line 131 of file gis.h.

Referenced by COM_Text_rotation(), G_math_findzc(), RTreeRectVolume(), and sphere_volume().

◆ M_PI_2

#define M_PI_2   1.57079632679489661923 /* pi/2 */

Definition at line 134 of file gis.h.

Referenced by G_math_findzc(), and G_rhumbline_lat_from_lon().

◆ M_PI_4

#define M_PI_4   0.78539816339744830962 /* pi/4 */

Definition at line 137 of file gis.h.

◆ M_R2D

#define M_R2D   57.295779513082320877 /* 180/pi */

Definition at line 140 of file gis.h.

Referenced by IL_secpar_loop_2d().

◆ NEWLINE

#define NEWLINE   '\n'

Cross-platform Newline Character.

Definition at line 70 of file gis.h.

◆ NO

◆ PRI_OFF_T

#define PRI_OFF_T   "ld"

◆ PROJECTION_FILE

#define PROJECTION_FILE   "PROJ_INFO"

Definition at line 117 of file gis.h.

Referenced by G_get_projinfo().

◆ PROJECTION_LL

◆ PROJECTION_OTHER

#define PROJECTION_OTHER   99

Projection code - other projection (other then noted above)

Definition at line 115 of file gis.h.

Referenced by G_projection_name(), GPJ_osr_to_grass(), and Vect_get_proj_name().

◆ PROJECTION_SP

#define PROJECTION_SP   2

Projection code - State Plane.

Definition at line 111 of file gis.h.

◆ PROJECTION_UTM

#define PROJECTION_UTM   1

Projection code - UTM.

Definition at line 109 of file gis.h.

Referenced by G_database_projection_name(), G_projection_name(), G_projection_units(), GPJ_osr_to_grass(), and Vect_get_proj_name().

◆ PROJECTION_XY

#define PROJECTION_XY   0

Projection code - XY coordinate system (unreferenced data)

Definition at line 107 of file gis.h.

Referenced by G_database_projection_name(), G_get_projepsg(), G_get_projinfo(), G_get_projunits(), G_projection_name(), G_projection_units(), and Vect_get_proj_name().

◆ serialize_int32_be

#define serialize_int32_be (   buf,
  x 
)
Value:
do { \
(buf)[0] = ((x) >> 24) & 0xFF; \
(buf)[1] = ((x) >> 16) & 0xFF; \
(buf)[2] = ((x) >> 8) & 0xFF; \
(buf)[3] = ((x) >> 0) & 0xFF; \
} while(0)
#define x

Definition at line 191 of file gis.h.

◆ serialize_int32_le

#define serialize_int32_le (   buf,
  x 
)
Value:
do { \
(buf)[0] = ((x) >> 0) & 0xFF; \
(buf)[1] = ((x) >> 8) & 0xFF; \
(buf)[2] = ((x) >> 16) & 0xFF; \
(buf)[3] = ((x) >> 24) & 0xFF; \
} while(0)
#define x

Definition at line 177 of file gis.h.

◆ SRID_FILE

#define SRID_FILE   "PROJ_SRID"

Definition at line 121 of file gis.h.

Referenced by G_write_projsrid().

◆ TRUE

◆ TYPE_DOUBLE

#define TYPE_DOUBLE   2

Definition at line 158 of file gis.h.

Referenced by G_define_standard_option(), and N_define_standard_option().

◆ TYPE_INTEGER

#define TYPE_INTEGER   1

Definition at line 157 of file gis.h.

Referenced by G_define_standard_option(), and N_define_standard_option().

◆ TYPE_STRING

#define TYPE_STRING   3

◆ U_ACRES

#define U_ACRES   1

◆ U_DAYS

#define U_DAYS   DATETIME_DAY

Definition at line 101 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ U_DEGREES

#define U_DEGREES   8

Definition at line 96 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_spatial(), G_projection_units(), and G_units().

◆ U_FEET

#define U_FEET   6

◆ U_HECTARES

#define U_HECTARES   2

◆ U_HOURS

#define U_HOURS   DATETIME_HOUR

Definition at line 102 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ U_KILOMETERS

#define U_KILOMETERS   3

◆ U_METERS

◆ U_MILES

#define U_MILES   5

◆ U_MINUTES

#define U_MINUTES   DATETIME_MINUTE

Definition at line 103 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ U_MONTHS

#define U_MONTHS   DATETIME_MONTH

Definition at line 100 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ U_RADIANS

#define U_RADIANS   7

Definition at line 95 of file gis.h.

Referenced by G_is_units_type_spatial().

◆ U_SECONDS

#define U_SECONDS   DATETIME_SECOND

Definition at line 104 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ U_UNDEFINED

#define U_UNDEFINED   -1

List of units.

Definition at line 87 of file gis.h.

Referenced by G_database_unit(), and G_projection_units().

◆ U_UNKNOWN

#define U_UNKNOWN   0

Definition at line 88 of file gis.h.

Referenced by G_get_units_name(), G_projection_units(), and G_units().

◆ U_USFEET

#define U_USFEET   9

◆ U_YEARS

#define U_YEARS   DATETIME_YEAR

Definition at line 99 of file gis.h.

Referenced by G_get_units_name(), G_is_units_type_temporal(), and G_units().

◆ UNIT_FILE

#define UNIT_FILE   "PROJ_UNITS"

Definition at line 118 of file gis.h.

Referenced by G_get_projunits().

◆ WARN_UNUSED_RESULT

#define WARN_UNUSED_RESULT

Generate warning if function return value is unused.

Definition at line 81 of file gis.h.

◆ WKT_FILE

#define WKT_FILE   "PROJ_WKT"

Definition at line 120 of file gis.h.

Referenced by G_write_projwkt().

◆ YES

#define YES   1

Definition at line 160 of file gis.h.

Referenced by G_define_standard_option(), and N_define_standard_option().

Typedef Documentation

◆ CELL

typedef int CELL

Definition at line 599 of file gis.h.

◆ DCELL

typedef double DCELL

Definition at line 600 of file gis.h.

◆ FCELL

typedef float FCELL

Definition at line 601 of file gis.h.

◆ LCELL

typedef grass_int64 LCELL

Definition at line 618 of file gis.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Element types identifiers (enum)

Identifies various element types. Element can be raster map, vector map, etc.

Enumerator
G_ELEMENT_RASTER 

raster

G_ELEMENT_RASTER3D 

3d raster

G_ELEMENT_VECTOR 

vector

G_ELEMENT_ASCIIVECTOR 

ASCII vector

G_ELEMENT_LABEL 

labels

G_ELEMENT_REGION 

region

G_ELEMENT_GROUP 

group

Definition at line 393 of file gis.h.

◆ rule_type

enum rule_type
Enumerator
RULE_EXCLUSIVE 
RULE_REQUIRED 
RULE_REQUIRES 
RULE_REQUIRES_ALL 
RULE_EXCLUDES 
RULE_COLLECTIVE 

Definition at line 346 of file gis.h.

◆ STD_FLG

enum STD_FLG

Standard flag identifiers (enum)

Identifies of all recognized standard flags.

Used by the G_parser() system.

Enumerator
G_FLG_UNDEFINED 
G_FLG_V_TABLE 

do not create attribute table

G_FLG_V_TOPO 

do not build topology

Definition at line 338 of file gis.h.

◆ STD_OPT

enum STD_OPT

Standard option identifiers (enum)

Identifies of all recognized standard options.

The term old in the descriptions means existing map which is supposed to exist before the module is called. On the other hand, the term new in the descriptions means that the map is not supposed to exist and that module will create one.

Used by the G_parser() system.

IMPORTANT NOTE: when adding new item to STD_OPT you should also update STD_OPT_STRINGS array in general/g.parser/standard_option.c.

Enumerator
G_OPT_UNDEFINED 
G_OPT_DB_SQL 

SQL statements

G_OPT_DB_WHERE 

SQL where conditions

G_OPT_DB_TABLE 

table name

G_OPT_DB_DRIVER 

driver name

G_OPT_DB_DATABASE 

database name

G_OPT_DB_SCHEMA 

database schema

G_OPT_DB_COLUMN 

one attr column

G_OPT_DB_COLUMNS 

one or more attr columns

G_OPT_DB_KEYCOLUMN 

key column

G_OPT_I_GROUP 

old input imagery group

G_OPT_I_SUBGROUP 

old input imagery subgroup

G_OPT_MEMORYMB 

Maximum memory to be used (in MB): cache size for raster rows

G_OPT_R_INPUT 

old input raster map

G_OPT_R_INPUTS 

old input raster maps

G_OPT_R_OUTPUT 

new output raster map

G_OPT_R_OUTPUTS 

new output raster maps

G_OPT_R_MAP 

old input raster map

G_OPT_R_MAPS 

old input rasters map

G_OPT_R_BASE 

old input base raster map

G_OPT_R_COVER 

old input cover raster map

G_OPT_R_ELEV 

old input elevation raster map

G_OPT_R_ELEVS 

old input elevation raster maps

G_OPT_R_TYPE 

raster map type

G_OPT_R_INTERP_TYPE 

interpolation type

G_OPT_R_BASENAME_INPUT 

old input basename raster maps

G_OPT_R_BASENAME_OUTPUT 

new output basename raster maps

G_OPT_R3_INPUT 

old input raster3d map

G_OPT_R3_INPUTS 

old input raster3d maps

G_OPT_R3_OUTPUT 

new output raster3d map

G_OPT_R3_MAP 

old input raster3d map

G_OPT_R3_MAPS 

old input raster3d maps

G_OPT_R3_TYPE 

Type (FCELL or DCELL) of a new created raster3d map

G_OPT_R3_PRECISION 

The precision of the new generated raster3d map

G_OPT_R3_TILE_DIMENSION 

The tile dimension of a new generated raster3d map

G_OPT_R3_COMPRESSION 

The kind of compression of a new created raster3d map

G_OPT_V_INPUT 

old input vector map

G_OPT_V_INPUTS 

old input vector maps

G_OPT_V_OUTPUT 

new output vector map

G_OPT_V_MAP 

old input vector map

G_OPT_V_MAPS 

old input vector maps

G_OPT_V_TYPE 

primitive type

G_OPT_V3_TYPE 

primitive type, 2D and 3D

G_OPT_V_FIELD 

layer number (layers used to be called fields)

G_OPT_V_FIELD_ALL 

layer number (layers used to be called fields)

G_OPT_V_CAT 

one category

G_OPT_V_CATS 

more categories

G_OPT_V_ID 

one feature id

G_OPT_V_IDS 

more feature ids

G_OPT_F_INPUT 

old input file

G_OPT_F_BIN_INPUT 

old binary input file

G_OPT_F_OUTPUT 

new output file

G_OPT_F_SEP 

data field separator

G_OPT_C 

color

G_OPT_CN 

color or none

G_OPT_M_UNITS 

units

G_OPT_M_DATATYPE 

datatype

G_OPT_M_MAPSET 

mapset

G_OPT_M_LOCATION 

location

G_OPT_M_DBASE 

dbase

G_OPT_M_COORDS 

coordinates

G_OPT_M_COLR 

color rules

G_OPT_M_DIR 

directory input

G_OPT_M_REGION 

saved region

G_OPT_M_NULL_VALUE 

null value string

G_OPT_STDS_INPUT 

old input space time dataset of type strds, str3ds or stvds

G_OPT_STDS_INPUTS 

old input space time datasets

G_OPT_STDS_OUTPUT 

new output space time dataset

G_OPT_STRDS_INPUT 

old input space time raster dataset

G_OPT_STRDS_INPUTS 

old input space time raster datasets

G_OPT_STRDS_OUTPUT 

new output space time raster dataset

G_OPT_STRDS_OUTPUTS 

new output space time raster datasets

G_OPT_STR3DS_INPUT 

old input space time raster3d dataset

G_OPT_STR3DS_INPUTS 

old input space time raster3d datasets

G_OPT_STR3DS_OUTPUT 

new output space time raster3d dataset

G_OPT_STVDS_INPUT 

old input space time vector dataset

G_OPT_STVDS_INPUTS 

old input space time vector datasets

G_OPT_STVDS_OUTPUT 

new output space time vector dataset

G_OPT_MAP_INPUT 

old input map of type raster, vector or raster3d

G_OPT_MAP_INPUTS 

old input maps of type raster, vector or raster3d

G_OPT_STDS_TYPE 

the type of a space time dataset: strds, str3ds, stvds

G_OPT_MAP_TYPE 

The type of an input map: raster, vect, rast3d

G_OPT_T_TYPE 

The temporal type of a space time dataset

G_OPT_T_WHERE 

A temporal GIS framework SQL WHERE statement

G_OPT_T_SAMPLE 

Temporal sample methods

Definition at line 231 of file gis.h.