ansys::Project::StorageFilesystem Class Reference | Ansys Developer Portal

Class for Storage on standard filesystem, for file:// URL. More...

#include "StorageFilesystem.hpp"

Inheritance diagram for ansys::Project::StorageFilesystem:

Public Member Functions
	StorageFilesystem ()
	Constructor. More...

virtual	~StorageFilesystem ()
	Destructor. More...

Error	createFolder (const URL &pParentPath, const Path &pFolderPath)
	See Storage::createFolder() More...

virtual bool	isFolder (const URL &pPath)
	See Storage::isFolder() More...

virtual bool	isFile (const URL &pPath)
	See Storage::isFile() More...

virtual Error	copyFile (const std::string &pSource, const std::string &pTarget)
	See Storage::copyFile() More...

virtual Error	eraseFile (const URL &pFile)
	See Storage::eraseFile() More...

virtual Error	eraseFolder (const URL &pFile, EraseOptions pRecursive)
	See Storage::eraseFolder() More...

virtual Error	moveFile (const URL &pSource, const URL &pTarget)
	See Storage::moveFile() More...

virtual Error	matchFiles (const URL &pPath, std::string pWildcard, std::vector< URL > &pMatchFiles)
	See Storage::matchFiles() More...

virtual std::string	getFileCompressionSuffix () const
	Returns the required file suffix for compressFile API. More...

virtual Error	compressFiles (const URL &pRootFolder, std::vector< URL > &pSourceFiles, const URL &pTargetArchive)
	See Storage::compressFile() More...

virtual Error	extractFile (const URL &pArchive, const URL &pTargetLocation)
	See Storage::extractFile() More...

virtual Error	getFileTimestamp (const URL &pFile, int &pTime)
	See Storage::getFileTimeStamp() More...

virtual Error	getFileChecksum (const URL &pFile, std::string &pChecksum)
	See Storage::getFileChecksum() More...

Public Member Functions inherited from ansys::Project::Storage
	Storage (const std::string &pTypename)
	Constructor. More...

virtual	~Storage ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from ansys::Project::Storage
enum	EraseOptions { EraseFolderOnly , EraseFolderAndFiles , EraseRecursively }

Static Public Member Functions inherited from ansys::Project::Storage
static void	registerInterface (const std::string &pType, Storage *pInterface)
	Register a Storage object to work with a specific URL type. More...

static Storage *	getInterface (const std::string &pType)
	Retrieve the Storage object to use with a specific URL type. More...

Detailed Description

Class for Storage on standard filesystem, for file:// URL.

Constructor & Destructor Documentation

◆ StorageFilesystem()

ansys::Project::StorageFilesystem::StorageFilesystem ( )

Constructor.

◆ ~StorageFilesystem()

ansys::Project::StorageFilesystem::~StorageFilesystem ( )

virtual

Destructor.

Member Function Documentation

◆ compressFiles()

Error ansys::Project::StorageFilesystem::compressFiles	(	const URL &	pRootFolder,
		std::vector< URL > &	pSourceFiles,
		const URL &	pTargetArchive
	)

virtual

See Storage::compressFile()

Implements ansys::Project::Storage.

◆ copyFile()

Error ansys::Project::StorageFilesystem::copyFile	(	const std::string &	pSource,
		const std::string &	pTarget
	)

virtual

See Storage::copyFile()

Implements ansys::Project::Storage.

◆ createFolder()

Error ansys::Project::StorageFilesystem::createFolder	(	const URL &	pParentPath,
		const Path &	pFolderPath
	)

virtual

See Storage::createFolder()

Implements ansys::Project::Storage.

◆ eraseFile()

Error ansys::Project::StorageFilesystem::eraseFile ( const URL & pFile )

virtual

See Storage::eraseFile()

Implements ansys::Project::Storage.

◆ eraseFolder()

Error ansys::Project::StorageFilesystem::eraseFolder	(	const URL &	pFile,
		Storage::EraseOptions	pFlagRecursive
	)

virtual

See Storage::eraseFolder()

Implements ansys::Project::Storage.

◆ extractFile()

Error ansys::Project::StorageFilesystem::extractFile	(	const URL &	pArchive,
		const URL &	pTargetLocation
	)

virtual

See Storage::extractFile()

Implements ansys::Project::Storage.

◆ getFileChecksum()

Error ansys::Project::StorageFilesystem::getFileChecksum	(	const URL &	pFile,
		std::string &	pChecksum
	)

virtual

See Storage::getFileChecksum()

Implements ansys::Project::Storage.

◆ getFileCompressionSuffix()

std::string ansys::Project::StorageFilesystem::getFileCompressionSuffix ( ) const

virtual

Returns the required file suffix for compressFile API.

Implements ansys::Project::Storage.

◆ getFileTimestamp()

Error ansys::Project::StorageFilesystem::getFileTimestamp	(	const URL &	pFile,
		int &	pTime
	)

virtual

See Storage::getFileTimeStamp()

Implements ansys::Project::Storage.

◆ isFile()

bool ansys::Project::StorageFilesystem::isFile ( const URL & pPath )

virtual

See Storage::isFile()

Implements ansys::Project::Storage.

◆ isFolder()

bool ansys::Project::StorageFilesystem::isFolder ( const URL & pPath )

virtual

See Storage::isFolder()

Implements ansys::Project::Storage.

◆ matchFiles()

Error ansys::Project::StorageFilesystem::matchFiles	(	const URL &	pPath,
		std::string	pWildcard,
		std::vector< URL > &	pMatchFiles
	)

virtual

See Storage::matchFiles()

Implements ansys::Project::Storage.

◆ moveFile()

Error ansys::Project::StorageFilesystem::moveFile	(	const URL &	pSource,
		const URL &	pTarget
	)

virtual

See Storage::moveFile()

Implements ansys::Project::Storage.

Home

Connect with Ansys