SAGA API  v9.5
Public Member Functions | Protected Attributes | List of all members
CSG_Strings Class Reference

#include <api_core.h>

Public Member Functions

 CSG_Strings (void)
 
 CSG_Strings (const CSG_Strings &Strings)
 
 CSG_Strings (int nStrings, const SG_Char **Strings)
 
virtual ~CSG_Strings (void)
 
bool Create (const CSG_Strings &Strings)
 
bool Destroy (void)
 
bool Set_Count (int Count)
 
bool Set_Count (size_t Count)
 
int Get_Count (void) const
 
size_t Get_Size (void) const
 
bool Add (const CSG_Strings &Strings)
 
bool Add (const CSG_String &String)
 
bool Ins (const CSG_String &String, int Index)
 
bool Ins (const CSG_String &String, size_t Index)
 
bool Del (int Index)
 
bool Del (size_t Index)
 
CSG_String & Get_String (int Index) const
 
CSG_String & Get_String (size_t Index) const
 
CSG_String & operator[] (int Index) const
 
CSG_String & operator[] (size_t Index) const
 
CSG_Strings & operator= (const CSG_Strings &Strings)
 
CSG_Strings & operator+= (const CSG_Strings &Strings)
 
CSG_Strings & operator+= (const CSG_String &String)
 
bool Sort (bool Ascending=true)
 
void Clear (void)
 
bool Assign (const CSG_Strings &Strings)
 

Protected Attributes

CSG_Array_Pointer m_Strings
 

Detailed Description

Definition at line 698 of file api_core.h.

Constructor & Destructor Documentation

◆ CSG_Strings() [1/3]

CSG_Strings::CSG_Strings ( void  )

Definition at line 977 of file api_string.cpp.

◆ CSG_Strings() [2/3]

CSG_Strings::CSG_Strings ( const CSG_Strings &  Strings)

Definition at line 981 of file api_string.cpp.

References Create().

◆ CSG_Strings() [3/3]

CSG_Strings::CSG_Strings ( int  nStrings,
const SG_Char **  Strings 
)

Definition at line 994 of file api_string.cpp.

References Add().

◆ ~CSG_Strings()

CSG_Strings::~CSG_Strings ( void  )
virtual

Definition at line 1003 of file api_string.cpp.

References Clear().

Member Function Documentation

◆ Add() [1/2]

bool CSG_Strings::Add ( const CSG_String &  String)

Definition at line 1033 of file api_string.cpp.

References Get_Size(), CSG_Array_Pointer::Inc_Array(), and m_Strings.

◆ Add() [2/2]

bool CSG_Strings::Add ( const CSG_Strings &  Strings)

Definition at line 1022 of file api_string.cpp.

References Get_Size().

Referenced by CSG_Parameter_Choice::Add_Item(), CSG_MetaData::Add_Property(), CSG_Unique_String_Statistics::Add_Value(), Create(), CSG_Strings(), CSG_Parameter_File_Name::Get_FilePaths(), Ins(), Set_Count(), and CSG_MetaData::Set_Property().

◆ Assign()

bool CSG_Strings::Assign ( const CSG_Strings &  Strings)
inline

Definition at line 735 of file api_core.h.

◆ Clear()

void CSG_Strings::Clear ( void  )
inline

Definition at line 734 of file api_core.h.

Referenced by CSG_Unique_String_Statistics::Create(), CSG_Parameter_Choice::Del_Items(), CSG_Parameter_Choices::Del_Items(), CSG_Parameters::Del_References(), CSG_Tool_Library::Del_References(), CSG_Regression_Multiple::Destroy(), CSG_MetaData::Destroy(), CSG_Parameters::Destroy(), CSG_Parameter_File_Name::Get_FilePaths(), CSG_Parameter_Choice::Set_Items(), SG_Dir_List_Files(), SG_Dir_List_Subdirectories(), and ~CSG_Strings().

◆ Create()

bool CSG_Strings::Create ( const CSG_Strings &  Strings)

Definition at line 986 of file api_string.cpp.

References Add(), and Destroy().

Referenced by CSG_Strings().

◆ Del() [1/2]

bool CSG_Strings::Del ( int  Index)
inline

Definition at line 719 of file api_core.h.

References Del().

Referenced by Del(), CSG_MetaData::Del_Property(), and Set_Count().

◆ Del() [2/2]

bool CSG_Strings::Del ( size_t  Index)

Definition at line 1071 of file api_string.cpp.

References CSG_Array_Pointer::Dec_Array(), Get_Size(), and m_Strings.

◆ Destroy()

bool CSG_Strings::Destroy ( void  )

Definition at line 1009 of file api_string.cpp.

References CSG_Array_Pointer::Destroy(), Get_Size(), and m_Strings.

Referenced by Create().

◆ Get_Count()

int CSG_Strings::Get_Count ( void  ) const
inline

Definition at line 712 of file api_core.h.

Referenced by CSG_Parameter_Choice::_Set_Value(), CSG_Tool_Library_Manager::Create_Python_ToolBox(), CSG_Parameter_File_Name::Get_FilePaths(), CSG_Parameter_Choices::Get_Items(), CSG_Tool::Get_MenuPath(), CSG_Tool::Get_Summary(), CSG_Tool_Library::Get_Summary(), CSG_Regression_Multiple::Set_Data(), CSG_Parameter_Choices::Set_Items(), CSG_Parameter_Choice::Set_Items(), SG_Dir_List_Files(), SG_Dir_List_Subdirectories(), SG_Initialize_Environment(), and Sort().

◆ Get_Size()

size_t CSG_Strings::Get_Size ( void  ) const
inline

Definition at line 713 of file api_core.h.

Referenced by Add(), Del(), Destroy(), Ins(), Set_Count(), and Sort().

◆ Get_String() [1/2]

CSG_String& CSG_Strings::Get_String ( int  Index) const
inline

Definition at line 722 of file api_core.h.

Referenced by CSG_Regression_Multiple::Set_Data().

◆ Get_String() [2/2]

CSG_String& CSG_Strings::Get_String ( size_t  Index) const
inline

Definition at line 723 of file api_core.h.

◆ Ins() [1/2]

bool CSG_Strings::Ins ( const CSG_String &  String,
int  Index 
)
inline

Definition at line 717 of file api_core.h.

References Ins().

Referenced by Ins().

◆ Ins() [2/2]

bool CSG_Strings::Ins ( const CSG_String &  String,
size_t  Index 
)

Definition at line 1048 of file api_string.cpp.

References Add(), Get_Size(), CSG_Array_Pointer::Inc_Array(), and m_Strings.

◆ operator+=() [1/2]

CSG_Strings& CSG_Strings::operator+= ( const CSG_String &  String)
inline

Definition at line 730 of file api_core.h.

◆ operator+=() [2/2]

CSG_Strings& CSG_Strings::operator+= ( const CSG_Strings &  Strings)
inline

Definition at line 729 of file api_core.h.

◆ operator=()

CSG_Strings& CSG_Strings::operator= ( const CSG_Strings &  Strings)
inline

Definition at line 728 of file api_core.h.

◆ operator[]() [1/2]

CSG_String& CSG_Strings::operator[] ( int  Index) const
inline

Definition at line 725 of file api_core.h.

◆ operator[]() [2/2]

CSG_String& CSG_Strings::operator[] ( size_t  Index) const
inline

Definition at line 726 of file api_core.h.

◆ Set_Count() [1/2]

bool CSG_Strings::Set_Count ( int  Count)
inline

Definition at line 710 of file api_core.h.

References Set_Count().

Referenced by CSG_Tool_Library_Interface::Create(), and Set_Count().

◆ Set_Count() [2/2]

bool CSG_Strings::Set_Count ( size_t  Count)

Definition at line 1091 of file api_string.cpp.

References Add(), Del(), and Get_Size().

◆ Sort()

bool CSG_Strings::Sort ( bool  Ascending = true)

Definition at line 1121 of file api_string.cpp.

References CSG_Array_Pointer::Get_Array(), Get_Count(), Get_Size(), and m_Strings.

Referenced by CSG_Parameters::Add_Reference(), and CSG_Tool_Library::Add_Reference().

Member Data Documentation

◆ m_Strings

CSG_Array_Pointer CSG_Strings::m_Strings
protected

Definition at line 740 of file api_core.h.

Referenced by Add(), Del(), Destroy(), Ins(), and Sort().

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