QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Macros | Typedefs | Functions | Variables
qgis.h File Reference
#include <QEvent>
#include <QString>
#include <QRegExp>
#include <QMetaType>
#include <QVariant>
#include <stdlib.h>
#include <cfloat>
#include <cmath>
#include <qnumeric.h>
Include dependency graph for qgis.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  QGis
 The QGis class provides global constants for use throughout the application. More...

Macros

#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
#define QGISEXTERN   extern "C"

Typedefs

typedef unsigned long long qgssize
 qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be hard to define size_t correctly in SIP.
typedef QMap< QString, QString > QgsStringMap

Functions

void CORE_EXPORT * qgsCalloc (size_t nmemb, size_t size)
 Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory.
bool qgsDoubleNear (double a, double b, double epsilon=4 *DBL_EPSILON)
bool qgsDoubleNearSig (double a, double b, int significantDigits=10)
QString qgsDoubleToString (const double &a, const int &precision=17)
void CORE_EXPORT qgsFree (void *ptr)
 Frees the memory space pointed to by ptr.
void CORE_EXPORT * qgsMalloc (size_t size)
 Allocates size bytes and returns a pointer to the allocated memory.
bool qgsVariantGreaterThan (const QVariant &lhs, const QVariant &rhs)
bool qgsVariantLessThan (const QVariant &lhs, const QVariant &rhs)
QString qgsVsiPrefix (QString path)

Variables

void(*)() cast_to_fptr (void *p)
const double DEFAULT_LINE_WIDTH = 0.26
const double DEFAULT_POINT_SIZE = 2.0
 Magic number that determines the default point size for point symbols.
const double DEFAULT_SEGMENT_EPSILON = 1e-8
 default snapping tolerance for segments
const int ELLPS_PREFIX_LEN = 7
 The length of the string "+ellps=".
CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID
 Geographic coord sys from EPSG authority.
const long GEO_EPSG_CRS_ID = 4326
 Magic number for a geographic coord sys in EpsgCrsId ID format.
CORE_EXPORT const QString GEO_NONE
 Constant that holds the string representation for "No ellips/No CRS".
const long GEOCRS_ID = 3452
 Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id.
CORE_EXPORT const QString GEOPROJ4
 PROJ4 string that represents a geographic coord sys.
const long GEOSRID = 4326
 Magic number for a geographic coord sys in POSTGIS SRID.
CORE_EXPORT const QString GEOWKT
 Wkt string that represents a geographic coord sys.
const int LAT_PREFIX_LEN = 7
 The length of the string "+lat_1=".
const double MINIMUM_POINT_SIZE = 0.1
 Magic number that determines the minimum allowable point size for point symbols.
const int PROJ_PREFIX_LEN = 6
 The length of the string "+proj=".
CORE_EXPORT const QString PROJECT_SCALES
const int USER_CRS_START_ID = 100000
 Magick number that determines whether a projection crsid is a system (srs.db) or user (~/.qgis.qgis.db) defined projection.

Macro Definition Documentation

#define Q_NOWARN_DEPRECATED_POP

Definition at line 442 of file qgis.h.

#define Q_NOWARN_DEPRECATED_PUSH

Definition at line 441 of file qgis.h.

#define QGISEXTERN   extern "C"

Definition at line 454 of file qgis.h.

Typedef Documentation

typedef unsigned long long qgssize

qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be hard to define size_t correctly in SIP.

Currently used "unsigned long long" was introduced in C++11 (2011) but it was supported already before C++11 on common platforms. "unsigned long long int" gives syntax error in SIP. KEEP IN SYNC WITH qgssize defined in SIP!

Definition at line 426 of file qgis.h.

typedef QMap<QString, QString> QgsStringMap

Definition at line 418 of file qgis.h.

Function Documentation

void CORE_EXPORT* qgsCalloc ( size_t  nmemb,
size_t  size 
)

Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory.

Works like C calloc() but prints debug message by QgsLogger if allocation fails.

Parameters
nmembnumber of elements
sizesize of element in bytes

Definition at line 202 of file qgis.cpp.

bool qgsDoubleNear ( double  a,
double  b,
double  epsilon = 4 * DBL_EPSILON 
)
inline

Definition at line 327 of file qgis.h.

bool qgsDoubleNearSig ( double  a,
double  b,
int  significantDigits = 10 
)
inline

Definition at line 336 of file qgis.h.

QString qgsDoubleToString ( const double &  a,
const int &  precision = 17 
)
inline

Definition at line 319 of file qgis.h.

void CORE_EXPORT qgsFree ( void *  ptr)

Frees the memory space pointed to by ptr.

Works like C free().

Parameters
ptrpointer to memory space

Definition at line 217 of file qgis.cpp.

void CORE_EXPORT* qgsMalloc ( size_t  size)

Allocates size bytes and returns a pointer to the allocated memory.

Works like C malloc() but prints debug message by QgsLogger if allocation fails.

Parameters
sizesize in bytes

Definition at line 187 of file qgis.cpp.

bool qgsVariantGreaterThan ( const QVariant &  lhs,
const QVariant &  rhs 
)

Definition at line 249 of file qgis.cpp.

bool qgsVariantLessThan ( const QVariant &  lhs,
const QVariant &  rhs 
)

Definition at line 222 of file qgis.cpp.

QString qgsVsiPrefix ( QString  path)

Definition at line 254 of file qgis.cpp.

Variable Documentation

void( *)() cast_to_fptr(void *p)

Definition at line 303 of file qgis.h.

const double DEFAULT_LINE_WIDTH = 0.26

Definition at line 413 of file qgis.h.

const double DEFAULT_POINT_SIZE = 2.0

Magic number that determines the default point size for point symbols.

Definition at line 412 of file qgis.h.

const double DEFAULT_SEGMENT_EPSILON = 1e-8

default snapping tolerance for segments

Definition at line 416 of file qgis.h.

const int ELLPS_PREFIX_LEN = 7

The length of the string "+ellps=".

Definition at line 395 of file qgis.h.

CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID

Geographic coord sys from EPSG authority.

Definition at line 71 of file qgis.cpp.

const long GEO_EPSG_CRS_ID = 4326

Magic number for a geographic coord sys in EpsgCrsId ID format.

Definition at line 389 of file qgis.h.

CORE_EXPORT const QString GEO_NONE

Constant that holds the string representation for "No ellips/No CRS".

Definition at line 73 of file qgis.cpp.

const long GEOCRS_ID = 3452

Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id.

Definition at line 387 of file qgis.h.

CORE_EXPORT const QString GEOPROJ4

PROJ4 string that represents a geographic coord sys.

Definition at line 51 of file qgis.cpp.

const long GEOSRID = 4326

Magic number for a geographic coord sys in POSTGIS SRID.

Definition at line 385 of file qgis.h.

CORE_EXPORT const QString GEOWKT

Wkt string that represents a geographic coord sys.

Note
added to replace GEOWkt

Definition at line 54 of file qgis.cpp.

const int LAT_PREFIX_LEN = 7

The length of the string "+lat_1=".

Definition at line 397 of file qgis.h.

const double MINIMUM_POINT_SIZE = 0.1

Magic number that determines the minimum allowable point size for point symbols.

Definition at line 410 of file qgis.h.

const int PROJ_PREFIX_LEN = 6

The length of the string "+proj=".

Definition at line 393 of file qgis.h.

CORE_EXPORT const QString PROJECT_SCALES

Definition at line 67 of file qgis.cpp.

const int USER_CRS_START_ID = 100000

Magick number that determines whether a projection crsid is a system (srs.db) or user (~/.qgis.qgis.db) defined projection.

Definition at line 400 of file qgis.h.