SAGA API  v9.6
Public Member Functions | Static Public Member Functions | List of all members
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_Weighting & Get_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 1102 of file grid.h.

Constructor & Destructor Documentation

◆ CSG_Grid_Cell_Addressor()

CSG_Grid_Cell_Addressor::CSG_Grid_Cell_Addressor ( void  )

Definition at line 348 of file grid_system.cpp.

References CSG_Table::Add_Field(), SG_DATATYPE_Double, and SG_DATATYPE_Int.

Member Function Documentation

◆ Add_Parameters()

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

Definition at line 375 of file grid_system.cpp.

References _TL, CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Double(), CSG_Parameters::Add_Int(), CSG_Distance_Weighting::Add_Parameters(), CSG_String::Format(), Get_Count(), CSG_Parameters::Set_Enabled(), SG_GRIDCELLADDR_PARM_ANNULUS, SG_GRIDCELLADDR_PARM_CIRCLE, SG_GRIDCELLADDR_PARM_MAPUNIT, SG_GRIDCELLADDR_PARM_SECTOR, SG_GRIDCELLADDR_PARM_SIZEDBL, SG_GRIDCELLADDR_PARM_SQUARE, and SG_GRIDCELLADDR_PARM_WEIGHTING.

◆ Destroy()

bool CSG_Grid_Cell_Addressor::Destroy ( void  )

Definition at line 357 of file grid_system.cpp.

References CSG_Table::Del_Records().

◆ Enable_Parameters()

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

Definition at line 496 of file grid_system.cpp.

References CSG_Grid::asInt(), CSG_Distance_Weighting::Enable_Parameters(), CSG_Parameters::Set_Enabled(), SG_GRIDCELLADDR_PARM_ANNULUS, and SG_GRIDCELLADDR_PARM_SECTOR.

◆ Get_Count()

int CSG_Grid_Cell_Addressor::Get_Count ( void  ) const
inline

Definition at line 1137 of file grid.h.

Referenced by Add_Parameters().

◆ Get_Direction()

double CSG_Grid_Cell_Addressor::Get_Direction ( void  ) const
inline

Definition at line 1134 of file grid.h.

◆ Get_Distance()

double CSG_Grid_Cell_Addressor::Get_Distance ( int  Index) const
inline

Definition at line 1140 of file grid.h.

◆ Get_Radius()

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

Definition at line 1131 of file grid.h.

◆ Get_Radius_Inner()

double CSG_Grid_Cell_Addressor::Get_Radius_Inner ( void  ) const
inline

Definition at line 1132 of file grid.h.

◆ Get_Radius_Outer()

double CSG_Grid_Cell_Addressor::Get_Radius_Outer ( void  ) const
inline

Definition at line 1133 of file grid.h.

◆ Get_Tolerance()

double CSG_Grid_Cell_Addressor::Get_Tolerance ( void  ) const
inline

Definition at line 1135 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 1142 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 1141 of file grid.h.

◆ Get_Weighting()

CSG_Distance_Weighting& CSG_Grid_Cell_Addressor::Get_Weighting ( void  )
inline

Definition at line 1118 of file grid.h.

◆ Get_X()

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

Definition at line 1138 of file grid.h.

◆ Get_Y()

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

Definition at line 1139 of file grid.h.

◆ is_Annulus()

bool CSG_Grid_Cell_Addressor::is_Annulus ( void  ) const
inline

Definition at line 1122 of file grid.h.

◆ is_Circle()

bool CSG_Grid_Cell_Addressor::is_Circle ( void  ) const
inline

Definition at line 1121 of file grid.h.

◆ is_Sector()

bool CSG_Grid_Cell_Addressor::is_Sector ( void  ) const
inline

Definition at line 1123 of file grid.h.

◆ is_Square()

bool CSG_Grid_Cell_Addressor::is_Square ( void  ) const
inline

Definition at line 1120 of file grid.h.

◆ Set_Annulus() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Annulus ( class CSG_Parameters &  Parameters)

Definition at line 487 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 632 of file grid_system.cpp.

◆ Set_Circle() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Circle ( class CSG_Parameters &  Parameters)

Definition at line 486 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 626 of file grid_system.cpp.

◆ Set_Parameters()

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

Definition at line 446 of file grid_system.cpp.

References CSG_Grid::asDouble(), M_DEG_TO_RAD, Set_Annulus(), Set_Radius(), Set_Sector(), SG_GRIDCELLADDR_PARM_ANNULUS, SG_GRIDCELLADDR_PARM_CIRCLE, SG_GRIDCELLADDR_PARM_SECTOR, and SG_GRIDCELLADDR_PARM_SQUARE.

Referenced by Set_Annulus(), Set_Circle(), Set_Sector(), and Set_Square().

◆ Set_Radius()

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

Definition at line 614 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 488 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 638 of file grid_system.cpp.

◆ Set_Square() [1/2]

bool CSG_Grid_Cell_Addressor::Set_Square ( class CSG_Parameters &  Parameters)

Definition at line 485 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 620 of file grid_system.cpp.

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