dataobject.h File Reference

#include "mat_tools.h"
#include "metadata.h"

Go to the source code of this file.

Classes
class	CSG_Data_Object

Macros
#define	SG_META_SOURCE   "SOURCE"
#define	SG_META_FILEPATH   "FILE"
#define	SG_META_DATABASE   "DATABASE"
#define	SG_META_PROJECTION   "PROJECTION"
#define	SG_META_HISTORY   "HISTORY"
#define	DATAOBJECT_NOTSET   ((void *)NULL)
#define	DATAOBJECT_CREATE   ((void *)1)

Enumerations
enum	TSG_Data_Object_Type {   SG_DATAOBJECT_TYPE_Grid , SG_DATAOBJECT_TYPE_Grids , SG_DATAOBJECT_TYPE_Table , SG_DATAOBJECT_TYPE_Shapes ,   SG_DATAOBJECT_TYPE_TIN , SG_DATAOBJECT_TYPE_PointCloud , SG_DATAOBJECT_TYPE_Undefined }

Functions
SAGA_API_DLL_EXPORT void *	SG_Get_Create_Pointer (void)
SAGA_API_DLL_EXPORT CSG_String	SG_Get_DataObject_Identifier (TSG_Data_Object_Type Type)
SAGA_API_DLL_EXPORT CSG_String	SG_Get_DataObject_Name (TSG_Data_Object_Type Type)
SAGA_API_DLL_EXPORT CSG_String	SG_Get_DataObject_Class_Name (TSG_Data_Object_Type Type)
SAGA_API_DLL_EXPORT bool	SG_DataObject_Set_Max_Samples (sLong Max_Samples)
SAGA_API_DLL_EXPORT sLong	SG_DataObject_Get_Max_Samples (void)
SAGA_API_DLL_EXPORT void	SG_Set_History_Depth (int Depth)
SAGA_API_DLL_EXPORT int	SG_Get_History_Depth (void)
SAGA_API_DLL_EXPORT void	SG_Set_History_Ignore_Lists (int Ignore)
SAGA_API_DLL_EXPORT int	SG_Get_History_Ignore_Lists (void)
SAGA_API_DLL_EXPORT bool	SG_Data_Object_Delete (CSG_Data_Object *pObject)

Detailed Description

Base class for data objects and related declarations.

See also

CSG_Data_Object

CSG_History

Definition in file dataobject.h.

Macro Definition Documentation

DATAOBJECT_CREATE

#define DATAOBJECT_CREATE   ((void *)1)

Definition at line 130 of file dataobject.h.

Referenced by CSG_Parameter_Data_Object::_Serialize(), CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_Data_Object_Output::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Data_Collection::Add(), CSG_Data_Manager::Add(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameter_List::Add_Item(), CSG_Parameter::asGrid(), CSG_Parameter::asGrids(), CSG_Parameter::asPointCloud(), CSG_Parameter::asShapes(), CSG_Parameter::asTable(), CSG_Parameter::asTIN(), CSG_Parameter::Check(), CSG_Data_Manager::Exists(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameter_Table_Field::Get_Table(), CSG_Parameter_Table_Fields::Get_Table(), CSG_Parameters::Serialize_Compatibility(), and SG_Get_Create_Pointer().

DATAOBJECT_NOTSET

#define DATAOBJECT_NOTSET   ((void *)NULL)

Definition at line 129 of file dataobject.h.

Referenced by CSG_Parameter_Data_Object::_Serialize(), CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_Data_Object_Output::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Data_Collection::Add(), CSG_Data_Manager::Add(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameter_List::Add_Item(), CSG_Parameter::Check(), and CSG_Parameters::Restore_Defaults().

SG_META_DATABASE

#define SG_META_DATABASE   "DATABASE"

Definition at line 91 of file dataobject.h.

Referenced by CSG_Data_Object::CSG_Data_Object(), and CSG_Data_Object::Load_MetaData().

SG_META_FILEPATH

#define SG_META_FILEPATH   "FILE"

Definition at line 90 of file dataobject.h.

Referenced by CSG_Data_Object::Load_MetaData(), and CSG_Data_Object::Save_MetaData().

SG_META_HISTORY

#define SG_META_HISTORY   "HISTORY"

Definition at line 93 of file dataobject.h.

Referenced by CSG_Data_Object::CSG_Data_Object(), CSG_Tool::Get_History(), and CSG_Data_Object::Load_MetaData().

SG_META_PROJECTION

#define SG_META_PROJECTION   "PROJECTION"

Definition at line 92 of file dataobject.h.

Referenced by CSG_Data_Object::Load_MetaData(), and CSG_Data_Object::Save_MetaData().

SG_META_SOURCE

#define SG_META_SOURCE   "SOURCE"

Definition at line 89 of file dataobject.h.

Referenced by CSG_Data_Object::CSG_Data_Object(), and CSG_Data_Object::Load_MetaData().

Enumeration Type Documentation

TSG_Data_Object_Type

enum TSG_Data_Object_Type

Definition of available data types. This is returned by the CSG_Data_Object::Get_ObjectType() function to allow type checking at run time.

See also

CSG_Data_Object

CSG_Table

CSG_PointCloud

CSG_Shapes

CSG_TIN

CSG_Grid

CSG_Grids

Enumerator
SG_DATAOBJECT_TYPE_Grid
SG_DATAOBJECT_TYPE_Grids
SG_DATAOBJECT_TYPE_Table
SG_DATAOBJECT_TYPE_Shapes
SG_DATAOBJECT_TYPE_TIN
SG_DATAOBJECT_TYPE_PointCloud
SG_DATAOBJECT_TYPE_Undefined

Definition at line 116 of file dataobject.h.

Function Documentation

SG_Data_Object_Delete()

SAGA_API_DLL_EXPORT bool SG_Data_Object_Delete

(

CSG_Data_Object *

pObject

)

Safe CSG_Data_Object destruction

Definition at line 185 of file dataobject.cpp.

References CSG_Data_Object::Get_Managed().

SG_DataObject_Get_Max_Samples()

SAGA_API_DLL_EXPORT sLong SG_DataObject_Get_Max_Samples

(

void

)

Get the default value for the number of maximum samples used for building data object statistics

Definition at line 139 of file dataobject.cpp.

References gSG_DataObject_Max_Samples.

Referenced by CSG_Grid::Create(), and CSG_Grid::Create().

SG_DataObject_Set_Max_Samples()

SAGA_API_DLL_EXPORT bool SG_DataObject_Set_Max_Samples

(

sLong

Max_Samples

)

Set the default value for the number of maximum samples used for building data object statistics

Definition at line 126 of file dataobject.cpp.

References gSG_DataObject_Max_Samples.

SG_Get_Create_Pointer()

SAGA_API_DLL_EXPORT void * SG_Get_Create_Pointer

(

void

)

Definition at line 65 of file dataobject.cpp.

References DATAOBJECT_CREATE.

SG_Get_DataObject_Class_Name()

SAGA_API_DLL_EXPORT CSG_String SG_Get_DataObject_Class_Name

(

TSG_Data_Object_Type

Type

)

Definition at line 101 of file dataobject.cpp.

References SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_Table, and SG_DATAOBJECT_TYPE_TIN.

SG_Get_DataObject_Identifier()

SAGA_API_DLL_EXPORT CSG_String SG_Get_DataObject_Identifier

(

TSG_Data_Object_Type

Type

)

Definition at line 71 of file dataobject.cpp.

References SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_Table, and SG_DATAOBJECT_TYPE_TIN.

SG_Get_DataObject_Name()

SAGA_API_DLL_EXPORT CSG_String SG_Get_DataObject_Name

(

TSG_Data_Object_Type

Type

)

Definition at line 86 of file dataobject.cpp.

References _TL, SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_Table, and SG_DATAOBJECT_TYPE_TIN.

Referenced by CSG_Parameter::Get_Description(), and SG_XML_Add_Parameter().

SG_Get_History_Depth()

SAGA_API_DLL_EXPORT int SG_Get_History_Depth

(

void

)

Definition at line 159 of file dataobject.cpp.

References g_History_Depth.

Referenced by CSG_Tool::DataObject_Set_History().

SG_Get_History_Ignore_Lists()

SAGA_API_DLL_EXPORT int SG_Get_History_Ignore_Lists

(

void

)

Definition at line 172 of file dataobject.cpp.

References g_History_Ignore_Lists.

Referenced by CSG_Parameters::Set_History().

SG_Set_History_Depth()

SAGA_API_DLL_EXPORT void SG_Set_History_Depth

(

int

Depth

)

Definition at line 154 of file dataobject.cpp.

References g_History_Depth.

SG_Set_History_Ignore_Lists()

SAGA_API_DLL_EXPORT void SG_Set_History_Ignore_Lists

(

int

Ignore

)

Definition at line 167 of file dataobject.cpp.

References g_History_Ignore_Lists.