tool_library.h File Reference

#include "tool.h"

Go to the source code of this file.

Classes
class	CSG_Tool_Library
class	CSG_Tool_Library_Manager

Macros
#define	SG_RUN_TOOL(bRetVal, LIBRARY, TOOL, CONDITION)
#define	SG_RUN_TOOL_ExitOnError(LIBRARY, TOOL, CONDITION)
#define	SG_RUN_TOOL_KEEP_PARMS(bRetVal, LIBRARY, TOOL, PARMS, CONDITION)
#define	SG_RUN_TOOL_KEEP_PARMS_ExitOnError(LIBRARY, TOOL, PARMS, CONDITION)
#define	SG_TOOL_PARAMETER_SET(IDENTIFIER, VALUE)   (pTool->Get_Parameters()->Get_Parameter(IDENTIFIER, true) && pTool->Set_Parameter(IDENTIFIER, VALUE))
#define	SG_TOOL_PARAMLIST_ADD(IDENTIFIER, VALUE)
#define	SG_TOOL_SET_DATAOBJECT_LIST(IDENTIFIER, VALUE)

Enumerations
enum	ESG_Library_Type { ESG_Library_Type::Library, ESG_Library_Type::Chain, ESG_Library_Type::Undefined }

Functions
SAGA_API_DLL_EXPORT CSG_Tool_Library_Manager &	SG_Get_Tool_Library_Manager (void)

Detailed Description

The definitions needed for any SAGA tool library and the tool library management, including the SAGA API's default tool library manager.

See also

SG_Get_Tool_Library_Manager

CSG_Tool_Library_Manager

CSG_Tool_Library

Definition in file tool_library.h.

Macro Definition Documentation

SG_RUN_TOOL

#define SG_RUN_TOOL	(		bRetVal,
			LIBRARY,
			TOOL,
			CONDITION
	)

Definition at line 260 of file tool_library.h.

SG_RUN_TOOL_ExitOnError

#define SG_RUN_TOOL_ExitOnError	(		LIBRARY,
			TOOL,
			CONDITION
	)

Value:

        {\
        \
        bool bResult;\
	\
	SG_RUN_TOOL(bResult, LIBRARY, TOOL, CONDITION)\
        \
        if( !bResult )\
        {\
                return( false );\
        }\
}

Definition at line 293 of file tool_library.h.

SG_RUN_TOOL_KEEP_PARMS

#define SG_RUN_TOOL_KEEP_PARMS	(		bRetVal,
			LIBRARY,
			TOOL,
			PARMS,
			CONDITION
	)

Definition at line 306 of file tool_library.h.

SG_RUN_TOOL_KEEP_PARMS_ExitOnError

#define SG_RUN_TOOL_KEEP_PARMS_ExitOnError	(		LIBRARY,
			TOOL,
			PARMS,
			CONDITION
	)

Value:

        {\
        \
        bool bResult;\
	\
	SG_RUN_TOOL_KEEP_PARMS(bResult, LIBRARY, TOOL, PARMS, CONDITION)\
        \
        if( !bResult )\
        {\
                return( false );\
        }\
}

Definition at line 341 of file tool_library.h.

SG_TOOL_PARAMETER_SET

#define SG_TOOL_PARAMETER_SET	(		IDENTIFIER,
			VALUE
	)		(pTool->Get_Parameters()->Get_Parameter(IDENTIFIER, true) && pTool->Set_Parameter(IDENTIFIER, VALUE))

Definition at line 354 of file tool_library.h.

SG_TOOL_PARAMLIST_ADD

#define SG_TOOL_PARAMLIST_ADD	(		IDENTIFIER,
			VALUE
	)

Value:

                (\
                pTool->Get_Parameters()->Get_Parameter(IDENTIFIER, true)\
        &&      pTool->Get_Parameters()->Get_Parameter(IDENTIFIER)->asList()\
        &&      pTool->Get_Parameters()->Get_Parameter(IDENTIFIER)->asList()->Add_Item(VALUE)\
)

Definition at line 356 of file tool_library.h.

SG_TOOL_SET_DATAOBJECT_LIST

#define SG_TOOL_SET_DATAOBJECT_LIST	(		IDENTIFIER,
			VALUE
	)

Value:

                (\
                pTool->Get_Parameters()->Get_Parameter(IDENTIFIER, true)\
        &&      pTool->Get_Parameters()->Get_Parameter(IDENTIFIER)->asList()\
        &&      pTool->Get_Parameters()->Get_Parameter(IDENTIFIER)->asList()->Assign(VALUE)\
)

Definition at line 362 of file tool_library.h.

Enumeration Type Documentation

ESG_Library_Type

enum ESG_Library_Type

strong

Enumerator
Library
Chain
Undefined

Definition at line 91 of file tool_library.h.

Function Documentation

SG_Get_Tool_Library_Manager()

SAGA_API_DLL_EXPORT CSG_Tool_Library_Manager& SG_Get_Tool_Library_Manager

(

void

)

Definition at line 286 of file tool_library.cpp.

References g_Tool_Library_Manager.

Referenced by CSG_Parameters_CRSPicker::Activate_GUI(), CSG_Tool_Library_Manager::Add_Default_Libraries(), CSG_Shapes::Create(), CSG_Table::Create(), CSG_Tool_Library_Manager::Create_Tool(), CSG_Parameters_CRSPicker::Deactivate_GUI(), CSG_Tool_Library_Manager::Get_Library(), CSG_Tool_Library_Manager::Get_Tool(), CSG_Projections::Parse(), SG_Get_Projected(), and SG_Initialize_Environment().