SAGA API  v9.6
saga_api.h File Reference
#include "tool_library.h"
#include "data_manager.h"

Go to the source code of this file.

Macros

#define SAGA_MAJOR_VERSION   9
 
#define SAGA_MINOR_VERSION   6
 
#define SAGA_RELEASE_NUMBER   0
 
#define SAGA_VERSION   SG_T("9.6.0")
 

Functions

SAGA_API_DLL_EXPORT const SG_CharSAGA_API_Get_Version (void)
 
SAGA_API_DLL_EXPORT int SG_Compare_Version (const CSG_String &Version, int Major, int Minor, int Release)
 
SAGA_API_DLL_EXPORT int SG_Compare_Version (const CSG_String &Version, const CSG_String &Release)
 
SAGA_API_DLL_EXPORT int SG_Compare_SAGA_Version (const CSG_String &Version)
 
SAGA_API_DLL_EXPORT int SG_Compare_SAGA_Version (int Major, int Minor, int Release)
 

Detailed Description

This is the central header to include the complete SAGA API.

Definition in file saga_api.h.

Macro Definition Documentation

◆ SAGA_MAJOR_VERSION

#define SAGA_MAJOR_VERSION   9

Definition at line 87 of file saga_api.h.

◆ SAGA_MINOR_VERSION

#define SAGA_MINOR_VERSION   6

Definition at line 88 of file saga_api.h.

◆ SAGA_RELEASE_NUMBER

#define SAGA_RELEASE_NUMBER   0

Definition at line 89 of file saga_api.h.

◆ SAGA_VERSION

#define SAGA_VERSION   SG_T("9.6.0")

Definition at line 90 of file saga_api.h.

Function Documentation

◆ SAGA_API_Get_Version()

SAGA_API_DLL_EXPORT const SG_Char* SAGA_API_Get_Version ( void  )

Definition at line 63 of file saga_api.cpp.

References SAGA_VERSION, and SG_T.

◆ SG_Compare_SAGA_Version() [1/2]

SAGA_API_DLL_EXPORT int SG_Compare_SAGA_Version ( const CSG_String Version)

Compares to current SAGA version and returns -1 if it is less, 1 if it is greater or 0 if it is equal. Version string is assumed to have the form 'Major.Minor.Release'.

Definition at line 146 of file saga_api.cpp.

References CSG_String::AfterFirst(), CSG_String::AfterLast(), CSG_String::asInt(), and SG_Compare_SAGA_Version().

◆ SG_Compare_SAGA_Version() [2/2]

SAGA_API_DLL_EXPORT int SG_Compare_SAGA_Version ( int  Major,
int  Minor,
int  Release 
)

Compares to current SAGA version and returns -1 if it is less, 1 if it is greater or 0 if it is equal.

Definition at line 125 of file saga_api.cpp.

References SAGA_MAJOR_VERSION, SAGA_MINOR_VERSION, and SAGA_RELEASE_NUMBER.

Referenced by SG_Compare_SAGA_Version().

◆ SG_Compare_Version() [1/2]

SAGA_API_DLL_EXPORT int SG_Compare_Version ( const CSG_String Version,
const CSG_String Release 
)

Compares two versions numbers. Returns -1 if it is less, 1 if it is greater or 0 if it is equal. Version strings are assumed to have the form 'Major.Minor.Release'.

Definition at line 108 of file saga_api.cpp.

References CSG_String::AfterFirst(), CSG_String::AfterLast(), CSG_String::asInt(), and SG_Compare_Version().

◆ SG_Compare_Version() [2/2]

SAGA_API_DLL_EXPORT int SG_Compare_Version ( const CSG_String Version,
int  Major,
int  Minor,
int  Release 
)

Compares two versions numbers. Returns -1 if it is less, 1 if it is greater or 0 if it is equal. Version string is assumed to have the form 'Major.Minor.Release'.

Definition at line 82 of file saga_api.cpp.

References CSG_String::AfterFirst(), CSG_String::AfterLast(), and CSG_String::asInt().

Referenced by CSG_Tool_Chain::Create(), CSG_Classifier_Supervised::Load(), and SG_Compare_Version().