MeshKernel
GriddedSamples.hpp
1 //---- GPL ---------------------------------------------------------------------
2 //
3 // Copyright (C) Stichting Deltares, 2011-2021.
4 //
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation version 3.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // contact: delft3d.support@deltares.nl
18 // Stichting Deltares
19 // P.O. Box 177
20 // 2600 MH Delft, The Netherlands
21 //
22 // All indications and logos of, and references to, "Delft3D" and "Deltares"
23 // are registered trademarks of Stichting Deltares, and remain the property of
24 // Stichting Deltares. All rights reserved.
25 //
26 //------------------------------------------------------------------------------
27 
28 #pragma once
29 
30 namespace meshkernelapi
31 {
34  {
36  int num_x = 0;
37 
39  int num_y = 0;
40 
42  double x_origin = 0.0;
43 
45  double y_origin = 0.0;
46 
48  double cell_size = 0.0;
49 
51  double* x_coordinates = nullptr;
52 
54  double* y_coordinates = nullptr;
55 
57  void* values = nullptr;
58 
60  int value_type = 1;
61  };
62 } // namespace meshkernelapi
meshkernelapi::GriddedSamples::cell_size
double cell_size
Constant grid cell size.
Definition: GriddedSamples.hpp:48
meshkernelapi::GriddedSamples::num_x
int num_x
Number of x gridded samples coordinates.
Definition: GriddedSamples.hpp:36
meshkernelapi::GriddedSamples::y_origin
double y_origin
Y coordinate of the grid origin (lower left corner)
Definition: GriddedSamples.hpp:45
meshkernelapi::GriddedSamples::y_coordinates
double * y_coordinates
If not nullptr, coordinates for non-uniform grid spacing in y direction.
Definition: GriddedSamples.hpp:54
meshkernelapi::GriddedSamples::x_coordinates
double * x_coordinates
If not nullptr, coordinates for non-uniform grid spacing in x direction.
Definition: GriddedSamples.hpp:51
meshkernelapi::GriddedSamples
A struct describing gridded samples.
Definition: GriddedSamples.hpp:33
meshkernelapi
Contains all structs and functions exposed at the API level.
Definition: BoundingBox.hpp:32
meshkernelapi::GriddedSamples::values
void * values
Sample values.
Definition: GriddedSamples.hpp:57
meshkernelapi::GriddedSamples::x_origin
double x_origin
X coordinate of the grid origin (lower left corner)
Definition: GriddedSamples.hpp:42
meshkernelapi::GriddedSamples::num_y
int num_y
Number of y gridded samples coordinates.
Definition: GriddedSamples.hpp:39
meshkernelapi::GriddedSamples::value_type
int value_type
the numeric representation of the values (0 = short, 1 = float)
Definition: GriddedSamples.hpp:60