Defines a radar definition. More...

#include "radardefinition.h"
#include "rave_debug.h"
#include "rave_alloc.h"
#include <string.h>

Classes
struct	_RadarDefinition_t
	Represents the area. More...

Functions
int	RadarDefinition_setID (RadarDefinition_t radar, const char id)
	Sets the ID for this definition.

const char *	RadarDefinition_getID (RadarDefinition_t *radar)
	Returns the ID for this definition.

int	RadarDefinition_setDescription (RadarDefinition_t radar, const char descr)
	Sets the description for this definition.

const char *	RadarDefinition_getDescription (RadarDefinition_t *radar)
	Returns the description for this definition.

void	RadarDefinition_setLongitude (RadarDefinition_t *radar, double lon)

double	RadarDefinition_getLongitude (RadarDefinition_t *radar)

void	RadarDefinition_setLatitude (RadarDefinition_t *radar, double lat)

double	RadarDefinition_getLatitude (RadarDefinition_t *radar)

void	RadarDefinition_setHeight (RadarDefinition_t *radar, double h)

double	RadarDefinition_getHeight (RadarDefinition_t *radar)

int	RadarDefinition_setElangles (RadarDefinition_t radar, unsigned int nangles, double angles)
	Sets the elevation angles.

int	RadarDefinition_getElangles (RadarDefinition_t radar, unsigned int nangles, double **angles)
	Returns the elevation angles.

void	RadarDefinition_setNrays (RadarDefinition_t *radar, long nrays)

long	RadarDefinition_getNrays (RadarDefinition_t *radar)

void	RadarDefinition_setNbins (RadarDefinition_t *radar, long nbins)

long	RadarDefinition_getNbins (RadarDefinition_t *radar)

void	RadarDefinition_setScale (RadarDefinition_t *radar, double scale)

double	RadarDefinition_getScale (RadarDefinition_t *radar)

void	RadarDefinition_setBeamwidth (RadarDefinition_t *radar, double bw)

double	RadarDefinition_getBeamwidth (RadarDefinition_t *radar)

void	RadarDefinition_setBeamwH (RadarDefinition_t *radar, double bw)

double	RadarDefinition_getBeamwH (RadarDefinition_t *radar)

void	RadarDefinition_setBeamwV (RadarDefinition_t *radar, double bw)

double	RadarDefinition_getBeamwV (RadarDefinition_t *radar)

void	RadarDefinition_setWavelength (RadarDefinition_t *radar, double l)

double	RadarDefinition_getWavelength (RadarDefinition_t *radar)

void	RadarDefinition_setProjection (RadarDefinition_t radar, Projection_t projection)
	Sets the projection that defines this radar.

Projection_t *	RadarDefinition_getProjection (RadarDefinition_t *radar)
	Returns the projection that defines this radar.

Variables
RaveCoreObjectType	RadarDefinition_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Defines a radar definition.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2010-08-31

Function Documentation

◆ RadarDefinition_getBeamwH()

double RadarDefinition_getBeamwH ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the horizontal beam width

◆ RadarDefinition_getBeamwidth()

double RadarDefinition_getBeamwidth ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the beam width

◆ RadarDefinition_getBeamwV()

double RadarDefinition_getBeamwV ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the vertical beam width

◆ RadarDefinition_getDescription()

const char * RadarDefinition_getDescription ( RadarDefinition_t * radar )

Returns the description for this definition.

Parameters

[in] radar - self

◆ RadarDefinition_getElangles()

int RadarDefinition_getElangles	(	RadarDefinition_t *	radar,
		unsigned int *	nangles,
		double **	angles )

Returns the elevation angles.

Parameters

[in]	radar	- self
[out]	nangles	- the size of the angles array
[out]	angles	- the elevation angles in radians

Returns: 1 on success otherwise 0

◆ RadarDefinition_getHeight()

double RadarDefinition_getHeight ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the height

◆ RadarDefinition_getID()

const char * RadarDefinition_getID ( RadarDefinition_t * radar )

Returns the ID for this definition.

Parameters

[in] radar - self

◆ RadarDefinition_getLatitude()

double RadarDefinition_getLatitude ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the latitude in radians

◆ RadarDefinition_getLongitude()

double RadarDefinition_getLongitude ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the longitude in radians

◆ RadarDefinition_getNbins()

long RadarDefinition_getNbins ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the number of bins

◆ RadarDefinition_getNrays()

long RadarDefinition_getNrays ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the number of rays

◆ RadarDefinition_getProjection()

Projection_t * RadarDefinition_getProjection ( RadarDefinition_t * radar )

Returns the projection that defines this radar.

Parameters

[in] radar - self

Returns: the projection

◆ RadarDefinition_getScale()

double RadarDefinition_getScale ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the scale

◆ RadarDefinition_getWavelength()

double RadarDefinition_getWavelength ( RadarDefinition_t * radar )

Parameters

[in] radar - self

Returns: the wave length

◆ RadarDefinition_setBeamwH()

void RadarDefinition_setBeamwH	(	RadarDefinition_t *	radar,
		double	bw )

Parameters

[in]	radar	- self
[in]	bw	- the horizontal beam width to set

◆ RadarDefinition_setBeamwidth()

void RadarDefinition_setBeamwidth	(	RadarDefinition_t *	radar,
		double	bw )

Parameters

[in]	radar	- self
[in]	bw	- the beam width to set

◆ RadarDefinition_setBeamwV()

void RadarDefinition_setBeamwV	(	RadarDefinition_t *	radar,
		double	bw )

Parameters

[in]	radar	- self
[in]	bw	- the vertical beam width to set

◆ RadarDefinition_setDescription()

int RadarDefinition_setDescription	(	RadarDefinition_t *	radar,
		const char *	descr )

Sets the description for this definition.

Parameters

[in]	radar	- self
[in]	descr	- the description to set

Returns: 1 on success otherwise 0

◆ RadarDefinition_setElangles()

int RadarDefinition_setElangles	(	RadarDefinition_t *	radar,
		unsigned int	nangles,
		double *	angles )

Sets the elevation angles.

Parameters

[in]	radar	- self
[in]	nangles	- the size of the angles array
[in]	angles	- the elevation angles in radians

Returns: 1 on success otherwise 0

◆ RadarDefinition_setHeight()

void RadarDefinition_setHeight	(	RadarDefinition_t *	radar,
		double	h )

Parameters

[in]	radar	- self
[in]	h	- the height above sea level (in meters)

◆ RadarDefinition_setID()

int RadarDefinition_setID	(	RadarDefinition_t *	radar,
		const char *	id )

Sets the ID for this definition.

Parameters

[in]	radar	- self
[in]	id	- the id

Returns: 1 on success otherwise 0

◆ RadarDefinition_setLatitude()

void RadarDefinition_setLatitude	(	RadarDefinition_t *	radar,
		double	lat )

Parameters

[in]	radar	- self
[in]	lat	- the latitude of the radar (in radians)

◆ RadarDefinition_setLongitude()

void RadarDefinition_setLongitude	(	RadarDefinition_t *	radar,
		double	lon )

Parameters

[in]	radar	- self
[in]	lon	- the longitude of the radar (in radians)

◆ RadarDefinition_setNbins()

void RadarDefinition_setNbins	(	RadarDefinition_t *	radar,
		long	nbins )

Parameters

[in]	radar	- self
[in]	nbins	- the number of bins to set

◆ RadarDefinition_setNrays()

void RadarDefinition_setNrays	(	RadarDefinition_t *	radar,
		long	nrays )

Parameters

[in]	radar	- self
[in]	nrays	- the number of rays to set

◆ RadarDefinition_setProjection()

void RadarDefinition_setProjection	(	RadarDefinition_t *	radar,
		Projection_t *	projection )

Sets the projection that defines this radar.

Parameters

[in]	radar	- self
[in]	projection	- the projection

◆ RadarDefinition_setScale()

void RadarDefinition_setScale	(	RadarDefinition_t *	radar,
		double	scale )

Parameters

[in]	radar	- self
[in]	scale	- the scale to set

◆ RadarDefinition_setWavelength()

void RadarDefinition_setWavelength	(	RadarDefinition_t *	radar,
		double	l )

Parameters

[in]	radar	- self
[in]	l	- the wave length to set

Variable Documentation

◆ RadarDefinition_TYPE

RaveCoreObjectType RadarDefinition_TYPE

Initial value:

= {
    "RadarDefinition",
    sizeof(RadarDefinition_t),
    RadarDefinition_constructor,
    RadarDefinition_destructor,
    RadarDefinition_copyconstructor
}

Type definition to use when creating a rave object.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ RadarDefinition_getBeamwH()

◆ RadarDefinition_getBeamwidth()

◆ RadarDefinition_getBeamwV()

◆ RadarDefinition_getDescription()

◆ RadarDefinition_getElangles()

◆ RadarDefinition_getHeight()

◆ RadarDefinition_getID()

◆ RadarDefinition_getLatitude()

◆ RadarDefinition_getLongitude()

◆ RadarDefinition_getNbins()

◆ RadarDefinition_getNrays()

◆ RadarDefinition_getProjection()

◆ RadarDefinition_getScale()

◆ RadarDefinition_getWavelength()

◆ RadarDefinition_setBeamwH()

◆ RadarDefinition_setBeamwidth()

◆ RadarDefinition_setBeamwV()

◆ RadarDefinition_setDescription()

◆ RadarDefinition_setElangles()

◆ RadarDefinition_setHeight()

◆ RadarDefinition_setID()

◆ RadarDefinition_setLatitude()

◆ RadarDefinition_setLongitude()

◆ RadarDefinition_setNbins()

◆ RadarDefinition_setNrays()

◆ RadarDefinition_setProjection()

◆ RadarDefinition_setScale()

◆ RadarDefinition_setWavelength()

Variable Documentation

◆ RadarDefinition_TYPE