RAVE
area.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2009 Swedish Meteorological and Hydrological Institute, SMHI,
3
4This file is part of RAVE.
5
6RAVE is free software: you can redistribute it and/or modify
7it under the terms of the GNU Lesser General Public License as published by
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
10
11RAVE is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU Lesser General Public License for more details.
15
16You should have received a copy of the GNU Lesser General Public License
17along with RAVE. If not, see <http://www.gnu.org/licenses/>.
18------------------------------------------------------------------------*/
26#ifndef AREA_H
27#define AREA_H
28#include "rave_proj.h"
29#include "projection.h"
30#include "rave_object.h"
31
35typedef struct _Area_t Area_t;
36
41
48int Area_setID(Area_t* area, const char* id);
49
55const char* Area_getID(Area_t* area);
56
63int Area_setDescription(Area_t* area, const char* description);
64
70const char* Area_getDescription(Area_t* area);
71
77void Area_setXSize(Area_t* area, long xsize);
78
84long Area_getXSize(Area_t* area);
85
91void Area_setYSize(Area_t* area, long ysize);
92
98long Area_getYSize(Area_t* area);
99
105void Area_setXScale(Area_t* area, double xscale);
106
112double Area_getXScale(Area_t* area);
113
119void Area_setYScale(Area_t* area, double yscale);
120
126double Area_getYScale(Area_t* area);
127
136void Area_setExtent(Area_t* area, double llX, double llY, double urX, double urY);
137
146void Area_getExtent(Area_t* area, double* llX, double* llY, double* urX, double* urY);
147
154
161
170int Area_setPcsid(Area_t* area, const char* pcsid);
171
177const char* Area_getPcsid(Area_t* area);
178
179#endif /* AREA_H */
void Area_getExtent(Area_t *area, double *llX, double *llY, double *urX, double *urY)
Returns the area extent (lower-left, upper-right)
Definition area.c:232
int Area_setPcsid(Area_t *area, const char *pcsid)
The pcsid (projection id) for this area.
Definition area.c:263
double Area_getYScale(Area_t *area)
Returns the yscale.
Definition area.c:217
long Area_getYSize(Area_t *area)
Returns the ysize.
Definition area.c:193
void Area_setProjection(Area_t *area, Projection_t *projection)
Sets the projection that defines this area.
Definition area.c:249
void Area_setYSize(Area_t *area, long ysize)
Sets the ysize.
Definition area.c:187
void Area_setXSize(Area_t *area, long xsize)
Sets the xsize.
Definition area.c:175
int Area_setID(Area_t *area, const char *id)
Sets the ID for this area.
Definition area.c:135
const char * Area_getPcsid(Area_t *area)
Returns the projection id for this area.
Definition area.c:292
long Area_getXSize(Area_t *area)
Returns the xsize.
Definition area.c:181
Projection_t * Area_getProjection(Area_t *area)
Returns the projection that defines this area.
Definition area.c:257
const char * Area_getID(Area_t *area)
Returns the ID for this area.
Definition area.c:149
int Area_setDescription(Area_t *area, const char *description)
Sets the description for this area.
Definition area.c:155
void Area_setYScale(Area_t *area, double yscale)
Sets the yscale.
Definition area.c:211
void Area_setExtent(Area_t *area, double llX, double llY, double urX, double urY)
Sets the area extent (lower-left, upper-right)
Definition area.c:223
const char * Area_getDescription(Area_t *area)
Returns the description for this area.
Definition area.c:169
double Area_getXScale(Area_t *area)
Returns the xscale.
Definition area.c:205
void Area_setXScale(Area_t *area, double xscale)
Sets the xscale.
Definition area.c:199
RaveCoreObjectType Area_TYPE
Type definition to use when creating a rave object.
Definition area.c:304
Wrapper around PROJ.4.
Generic implementation of an object that is used within rave.
Handles compatibility issues related to PROJ versions and the definitions.
Represents the area.
Definition area.c:34
char * description
the description
Definition area.c:38
double urY
upper right y-coordinate
Definition area.c:49
char * pcsid
the pcs id
Definition area.c:39
long ysize
ysize
Definition area.c:42
double urX
upper right x-coordinate
Definition area.c:48
Projection_t * projection
the projection that is used for this area
Definition area.c:51
double llX
lower left x-coordinate
Definition area.c:46
double llY
lower left y-coordinate
Definition area.c:47
double xscale
xscale
Definition area.c:43
double yscale
yscale
Definition area.c:44
long xsize
xsize
Definition area.c:41
Represents one projection.
Definition projection.c:55
The rave object type definition.
Definition rave_object.h:52