SAGA API: CSG_Archive Class Reference

SAGA API v9.10

Loading...

Searching...

No Matches

#include <api_core.h>

Inheritance diagram for CSG_Archive:

Public Member Functions
	CSG_Archive (void)
virtual	~CSG_Archive (void)
	CSG_Archive (const SG_Char *FileName, int Mode=SG_FILE_R, int Encoding=SG_FILE_ENCODING_ANSI)
virtual bool	Open (const SG_Char *FileName, int Mode=SG_FILE_R, int Encoding=SG_FILE_ENCODING_ANSI)
virtual bool	Open (const SG_Char *FileName, int Mode, bool bBinary, int Encoding)
virtual bool	Close (void)
virtual const CSG_String &	Get_Archive (void) const
virtual TSG_File_Type	Get_File_Type (void) const
bool	is_Zip (void) const
bool	is_Tar (void) const
bool	Add_Directory (const SG_Char *Name)
bool	Add_File (const SG_Char *Name, bool bBinary=true)
size_t	Get_File_Count (void)
bool	Get_File (const SG_Char *Name)
bool	Get_File (size_t Index)
virtual CSG_String	Get_File_Name (size_t Index)
bool	is_Directory (size_t Index)
bool	Extract_All (const SG_Char *toDirectory=NULL)
bool	Extract (const SG_Char File, const SG_Char toFile=NULL)
Public Member Functions inherited from CSG_File
	CSG_File (void)
virtual	~CSG_File (void)
	CSG_File (const SG_Char *FileName, int Mode=SG_FILE_R, bool bBinary=true, int Encoding=SG_FILE_ENCODING_ANSI)
virtual const CSG_String &	Get_File_Name (void) const
class wxStreamBase *	Get_Stream (void) const
bool	Set_Encoding (int Encoding)
int	Get_Encoding (void) const
bool	is_Open (void) const
bool	is_Reading (void) const
bool	is_Writing (void) const
bool	is_EOF (void) const
sLong	Length (void) const
bool	Seek (sLong Offset, int Origin=SG_FILE_START) const
bool	Seek_Start (void) const
bool	Seek_End (void) const
sLong	Tell (void) const
bool	Flush (void)
int	Printf (const char *Format,...)
int	Printf (const wchar_t *Format,...)
size_t	Read (void *Buffer, size_t Size, size_t Count=1) const
size_t	Write (void *Buffer, size_t Size, size_t Count=1) const
size_t	Read (CSG_String &Buffer, size_t Size) const
size_t	Write (const CSG_String &Buffer) const
bool	Read_Line (CSG_String &Line) const
int	Read_Char (void) const
int	Read_Int (bool bBigEndian=false) const
bool	Write_Int (int Value, bool bBigEndian=false)
double	Read_Double (bool bBigEndian=false) const
bool	Write_Double (double Value, bool bBigEndian=false)
bool	Scan (int &Value) const
bool	Scan (double &Value) const
bool	Scan (CSG_String &Value, SG_Char Separator) const
int	Scan_Int (void) const
double	Scan_Double (void) const
CSG_String	Scan_String (SG_Char Separator) const

Protected Attributes
TSG_File_Type	m_Type = SG_FILE_TYPE_NORMAL
CSG_String	m_Archive
CSG_Array_Pointer	m_Files
Protected Attributes inherited from CSG_File
int	m_Mode
int	m_Encoding
CSG_String	m_FileName
void *	m_pStream
void *	m_pConvert

Additional Inherited Members
Protected Member Functions inherited from CSG_File
void	On_Construction (void)

Detailed Description

Definition at line 1203 of file api_core.h.

Constructor & Destructor Documentation

◆ CSG_Archive() [1/2]

CSG_Archive::CSG_Archive ( void )

Definition at line 580 of file api_file.cpp.

References CSG_File::On_Construction().

◆ ~CSG_Archive()

CSG_Archive::~CSG_Archive ( void )

virtual

Definition at line 594 of file api_file.cpp.

References Close().

◆ CSG_Archive() [2/2]

CSG_Archive::CSG_Archive	(	const SG_Char *	FileName,
		int	Mode = SG_FILE_R,
		int	Encoding = SG_FILE_ENCODING_ANSI )

Definition at line 586 of file api_file.cpp.

References CSG_File::On_Construction(), Open(), and SG_Char.

Member Function Documentation

◆ Add_Directory()

bool CSG_Archive::Add_Directory ( const SG_Char * Name )

Definition at line 699 of file api_file.cpp.

References CSG_File::is_Writing(), CSG_File::m_pStream, and SG_Char.

◆ Add_File()

bool CSG_Archive::Add_File	(	const SG_Char *	Name,
		bool	bBinary = true )

Definition at line 705 of file api_file.cpp.

References CSG_File::is_Writing(), is_Zip(), CSG_File::m_FileName, CSG_File::m_pStream, and SG_Char.

Referenced by CSG_PointCloud::Save().

◆ Close()

bool CSG_Archive::Close ( void )

virtual

Reimplemented from CSG_File.

Definition at line 677 of file api_file.cpp.

References CSG_File::Close(), is_Zip(), m_Archive, and m_Files.

Referenced by Open(), and ~CSG_Archive().

◆ Extract()

bool CSG_Archive::Extract	(	const SG_Char *	File,
		const SG_Char *	toFile = NULL )

Definition at line 843 of file api_file.cpp.

References CSG_File::CSG_File(), CSG_File::Flush(), Get_File(), CSG_String::is_Empty(), CSG_File::is_EOF(), CSG_File::is_Open(), CSG_File::is_Reading(), m_Archive, CSG_File::m_Encoding, CSG_File::Read(), SG_Char, SG_File_Get_Path(), SG_File_Make_Path(), SG_FILE_W, SG_T, UNZIP_BUFFER, and CSG_File::Write().

Referenced by Extract_All().

◆ Extract_All()

bool CSG_Archive::Extract_All ( const SG_Char * toDirectory = NULL )

Definition at line 800 of file api_file.cpp.

References Extract(), Get_File_Count(), CSG_File::Get_File_Name(), is_Directory(), CSG_String::is_Empty(), CSG_File::is_Reading(), m_Archive, SG_Char, SG_Dir_Create(), SG_Dir_Exists(), SG_File_Get_Path(), SG_T, and SG_UI_Process_Set_Progress().

◆ Get_Archive()

virtual const CSG_String & CSG_Archive::Get_Archive ( void ) const

inlinevirtual

Definition at line 1216 of file api_core.h.

References m_Archive.

◆ Get_File() [1/2]

bool CSG_Archive::Get_File ( const SG_Char * Name )

Definition at line 765 of file api_file.cpp.

References Get_File(), CSG_File::is_Reading(), m_Files, and SG_Char.

Referenced by CSG_Grid_File_Info::Create(), Extract(), Get_File(), and CSG_PointCloud::Get_Header_Content().

◆ Get_File() [2/2]

bool CSG_Archive::Get_File ( size_t Index )

Definition at line 749 of file api_file.cpp.

References CSG_File::Get_File_Name(), CSG_File::is_Reading(), CSG_File::m_FileName, m_Files, and CSG_File::m_pStream.

◆ Get_File_Count()

size_t CSG_Archive::Get_File_Count ( void )

inline

Definition at line 1224 of file api_core.h.

References m_Files.

Referenced by CSG_Grid_File_Info::Create(), and Extract_All().

◆ Get_File_Name()

CSG_String CSG_Archive::Get_File_Name ( size_t Index )

virtual

Reimplemented from CSG_File.

Definition at line 782 of file api_file.cpp.

References CSG_File::is_Reading(), and m_Files.

Referenced by CSG_Grid_File_Info::Create().

◆ Get_File_Type()

virtual TSG_File_Type CSG_Archive::Get_File_Type ( void ) const

inlinevirtual

Reimplemented from CSG_File.

Definition at line 1217 of file api_core.h.

References m_Type.

◆ is_Directory()

bool CSG_Archive::is_Directory ( size_t Index )

Definition at line 738 of file api_file.cpp.

References CSG_File::is_Reading(), and m_Files.

Referenced by Extract_All().

◆ is_Tar()

bool CSG_Archive::is_Tar ( void ) const

inline

Definition at line 1219 of file api_core.h.

References m_Type, and SG_FILE_TYPE_TAR.

◆ is_Zip()

bool CSG_Archive::is_Zip ( void ) const

inline

Definition at line 1218 of file api_core.h.

References m_Type, and SG_FILE_TYPE_ZIP.

Referenced by Add_File(), Close(), and Open().

◆ Open() [1/2]

virtual bool CSG_Archive::Open	(	const SG_Char *	FileName,
		int	Mode,
		bool	bBinary,
		int	Encoding )

inlinevirtual

Reimplemented from CSG_File.

Definition at line 1212 of file api_core.h.

References Open(), and SG_Char.

Referenced by Open().

◆ Open() [2/2]

bool CSG_Archive::Open	(	const SG_Char *	FileName,
		int	Mode = SG_FILE_R,
		int	Encoding = SG_FILE_ENCODING_ANSI )

virtual

Definition at line 600 of file api_file.cpp.

References Close(), CSG_String::is_Empty(), CSG_File::is_Reading(), is_Zip(), m_Archive, m_Files, CSG_File::m_Mode, CSG_File::m_pStream, m_pStream_Base, m_Type, CSG_File::Set_Encoding(), SG_Char, SG_Dir_Exists(), SG_File_Cmp_Extension(), SG_File_Exists(), SG_File_Get_Path(), SG_FILE_R, SG_FILE_TYPE_TAR, SG_FILE_TYPE_ZIP, and SG_FILE_W.

Referenced by CSG_Archive().

Member Data Documentation

◆ m_Archive

CSG_String CSG_Archive::m_Archive

protected

Definition at line 1238 of file api_core.h.

Referenced by Close(), Extract(), Extract_All(), Get_Archive(), and Open().

◆ m_Files

CSG_Array_Pointer CSG_Archive::m_Files

protected

Definition at line 1240 of file api_core.h.

Referenced by Close(), Get_File(), Get_File(), Get_File_Count(), Get_File_Name(), is_Directory(), and Open().

◆ m_Type

TSG_File_Type CSG_Archive::m_Type = SG_FILE_TYPE_NORMAL

protected

Definition at line 1236 of file api_core.h.

Referenced by Get_File_Type(), is_Tar(), is_Zip(), and Open().

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

CSG_Archive
Generated on for SAGA API by 1.14.0