grid_cell.h File Reference

Structs and interfaces to handle grid cells. More...

#include <stdio.h>

Include dependency graph for grid_cell.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	grid_cell

Enumerations
enum	yac_edge_type { GREAT_CIRCLE = 0 , LAT_CIRCLE = 1 , LON_CIRCLE = 2 }
enum	yac_cell_type { LON_LAT_CELL , LAT_CELL , GREAT_CIRCLE_CELL , MIXED_CELL }

Functions
void	yac_init_grid_cell (struct grid_cell *cell)
void	yac_copy_grid_cell (struct grid_cell in_cell, struct grid_cell *out_cell)
void	yac_free_grid_cell (struct grid_cell *cell)

Detailed Description

Structs and interfaces to handle grid cells.

Copyright

Copyright (C) 2013 Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Rene Redler rene..nosp@m.redl.nosp@m.er@mp.nosp@m.imet.nosp@m..mpg..nosp@m.de

Version

1.0

Author

Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Rene Redler rene..nosp@m.redl.nosp@m.er@mp.nosp@m.imet.nosp@m..mpg..nosp@m.de

Definition in file grid_cell.h.

Enumeration Type Documentation

yac_cell_type

enum yac_cell_type

Enumerator
LON_LAT_CELL
LAT_CELL
GREAT_CIRCLE_CELL
MIXED_CELL

Definition at line 67 of file grid_cell.h.

yac_edge_type

enum yac_edge_type

Enumerator
GREAT_CIRCLE	great circle
LAT_CIRCLE	latitude circle
LON_CIRCLE	longitude circle

Definition at line 53 of file grid_cell.h.

Function Documentation

yac_copy_grid_cell()

void yac_copy_grid_cell	(	struct grid_cell	in_cell,
		struct grid_cell *	out_cell
	)

copies a given grid cell

Parameters

[in]	in_cell	cell to be copied
[out]	out_cell	copied cell

Remarks

out_cell needs to be a cell that has previously been initialised or a cell that already contains valid data

Definition at line 79 of file grid_cell.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_free_grid_cell()

void yac_free_grid_cell

(

struct grid_cell *

cell

)

frees all memory associated with a grid_cell object and reinitialised the cell

Parameters

[in,out]

cell

Definition at line 89 of file grid_cell.c.

Here is the call graph for this function:

Here is the caller graph for this function:

yac_init_grid_cell()

void yac_init_grid_cell

(

struct grid_cell *

cell

)

initiates a grid_cell object before the first being used a grid_cell object has to be initialised

Parameters

[in]

cell

object to be initialised

See also

free_grid_cell

get_grid_cell

Definition at line 59 of file grid_cell.c.

Here is the caller graph for this function: