SAGA API v9.10
Loading...
Searching...
No Matches
CSG_Grid_Cell_Addressor Class Reference

#include <grid.h>

Public Member Functions

 CSG_Grid_Cell_Addressor (void)
bool Destroy (void)
bool Set_Parameters (class CSG_Parameters &Parameters, int Type=0)
bool Set_Square (class CSG_Parameters &Parameters)
bool Set_Circle (class CSG_Parameters &Parameters)
bool Set_Annulus (class CSG_Parameters &Parameters)
bool Set_Sector (class CSG_Parameters &Parameters)
CSG_Distance_WeightingGet_Weighting (void)
bool is_Square (void) const
bool is_Circle (void) const
bool is_Annulus (void) const
bool is_Sector (void) const
bool Set_Radius (double Radius, bool bSquare=false)
bool Set_Square (double Radius)
bool Set_Circle (double Radius)
bool Set_Annulus (double Radius_Inner, double Radius_Outer)
bool Set_Sector (double Radius, double Direction, double Tolerance)
double Get_Radius (bool bOuter=true) const
double Get_Radius_Inner (void) const
double Get_Radius_Outer (void) const
double Get_Direction (void) const
double Get_Tolerance (void) const
int Get_Count (void) const
int Get_X (int Index, int Offset=0) const
int Get_Y (int Index, int Offset=0) const
double Get_Distance (int Index) const
double Get_Weight (int Index) const
bool Get_Values (int Index, int &x, int &y, double &Distance, double &Weight, bool bOffset=false) const

Static Public Member Functions

static bool Enable_Parameters (class CSG_Parameters &Parameters)
static bool Add_Parameters (class CSG_Parameters &Parameters, const CSG_String &Parent="", int Style=SG_GRIDCELLADDR_PARM_DEFAULT)

Detailed Description

Definition at line 1128 of file grid.h.

Constructor & Destructor Documentation

◆ CSG_Grid_Cell_Addressor()

CSG_Grid_Cell_Addressor::CSG_Grid_Cell_Addressor ( void )

Definition at line 417 of file grid_system.cpp.

References SG_DATATYPE_Double, and SG_DATATYPE_Int.

Member Function Documentation

◆ Add_Parameters()

◆ Destroy()

bool CSG_Grid_Cell_Addressor::Destroy ( void )

Definition at line 426 of file grid_system.cpp.

◆ Enable_Parameters()

bool CSG_Grid_Cell_Addressor::Enable_Parameters ( class CSG_Parameters & Parameters)
static

◆ Get_Count()

int CSG_Grid_Cell_Addressor::Get_Count ( void ) const
inline

Definition at line 1163 of file grid.h.

Referenced by Add_Parameters().

◆ Get_Direction()

double CSG_Grid_Cell_Addressor::Get_Direction ( void ) const
inline

Definition at line 1160 of file grid.h.

◆ Get_Distance()

double CSG_Grid_Cell_Addressor::Get_Distance ( int Index) const
inline

Definition at line 1166 of file grid.h.

◆ Get_Radius()

double CSG_Grid_Cell_Addressor::Get_Radius ( bool bOuter = true) const
inline

Definition at line 1157 of file grid.h.

◆ Get_Radius_Inner()

double CSG_Grid_Cell_Addressor::Get_Radius_Inner ( void ) const
inline

Definition at line 1158 of file grid.h.

◆ Get_Radius_Outer()

double CSG_Grid_Cell_Addressor::Get_Radius_Outer ( void ) const
inline

Definition at line 1159 of file grid.h.

◆ Get_Tolerance()

double CSG_Grid_Cell_Addressor::Get_Tolerance ( void ) const
inline

Definition at line 1161 of file grid.h.

◆ Get_Values()

bool CSG_Grid_Cell_Addressor::Get_Values ( int Index,
int & x,
int & y,
double & Distance,
double & Weight,
bool bOffset = false ) const
inline

Definition at line 1168 of file grid.h.

References CSG_Table_Record::asDouble(), and CSG_Table_Record::asInt().

◆ Get_Weight()

double CSG_Grid_Cell_Addressor::Get_Weight ( int Index) const
inline

Definition at line 1167 of file grid.h.

◆ Get_Weighting()

CSG_Distance_Weighting & CSG_Grid_Cell_Addressor::Get_Weighting ( void )
inline

Definition at line 1144 of file grid.h.

◆ Get_X()

int CSG_Grid_Cell_Addressor::Get_X ( int Index,
int Offset = 0 ) const
inline

Definition at line 1164 of file grid.h.

◆ Get_Y()

int CSG_Grid_Cell_Addressor::Get_Y ( int Index,
int Offset = 0 ) const
inline

Definition at line 1165 of file grid.h.

◆ is_Annulus()

bool CSG_Grid_Cell_Addressor::is_Annulus ( void ) const
inline

Definition at line 1148 of file grid.h.

◆ is_Circle()

bool CSG_Grid_Cell_Addressor::is_Circle ( void ) const
inline

Definition at line 1147 of file grid.h.

◆ is_Sector()

bool CSG_Grid_Cell_Addressor::is_Sector ( void ) const
inline

Definition at line 1149 of file grid.h.

◆ is_Square()

bool CSG_Grid_Cell_Addressor::is_Square ( void ) const
inline

Definition at line 1146 of file grid.h.

◆ Set_Annulus() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Annulus ( class CSG_Parameters & Parameters)

Definition at line 556 of file grid_system.cpp.

References Set_Parameters(), and SG_GRIDCELLADDR_PARM_ANNULUS.

Referenced by Set_Parameters().

◆ Set_Annulus() [2/2]

bool CSG_Grid_Cell_Addressor::Set_Annulus ( double Radius_Inner,
double Radius_Outer )

Definition at line 701 of file grid_system.cpp.

◆ Set_Circle() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Circle ( class CSG_Parameters & Parameters)

Definition at line 555 of file grid_system.cpp.

References Set_Parameters(), and SG_GRIDCELLADDR_PARM_CIRCLE.

Referenced by Set_Radius().

◆ Set_Circle() [2/2]

bool CSG_Grid_Cell_Addressor::Set_Circle ( double Radius)

Definition at line 695 of file grid_system.cpp.

◆ Set_Parameters()

bool CSG_Grid_Cell_Addressor::Set_Parameters ( class CSG_Parameters & Parameters,
int Type = 0 )

◆ Set_Radius()

bool CSG_Grid_Cell_Addressor::Set_Radius ( double Radius,
bool bSquare = false )

Definition at line 683 of file grid_system.cpp.

References Set_Circle(), and Set_Square().

Referenced by Set_Parameters().

◆ Set_Sector() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Sector ( class CSG_Parameters & Parameters)

Definition at line 557 of file grid_system.cpp.

References Set_Parameters(), and SG_GRIDCELLADDR_PARM_SECTOR.

Referenced by Set_Parameters().

◆ Set_Sector() [2/2]

bool CSG_Grid_Cell_Addressor::Set_Sector ( double Radius,
double Direction,
double Tolerance )

Definition at line 707 of file grid_system.cpp.

◆ Set_Square() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Square ( class CSG_Parameters & Parameters)

Definition at line 554 of file grid_system.cpp.

References Set_Parameters(), and SG_GRIDCELLADDR_PARM_SQUARE.

Referenced by Set_Radius().

◆ Set_Square() [2/2]

bool CSG_Grid_Cell_Addressor::Set_Square ( double Radius)

Definition at line 689 of file grid_system.cpp.


The documentation for this class was generated from the following files: