FilesystemPermissions Class Reference

#include <FilesystemPermissions.hpp>

Collaboration diagram for FilesystemPermissions:

Static Public Member Functions
static fs::perms	GetFilePermissions ()
static fs::perms	GetDirectoryPermissions ()
static void	SetFilePermissions (const fs::path &rPath)
static void	SetDirectoryPermissions (const fs::path &rPath)
static bool	CreateDirectoryWithPermissions (const fs::path &rPath)
static bool	CreateDirectoriesWithPermissions (const fs::path &rPath)
static void	CopyFileWithPermissions (const fs::path &rFromPath, const fs::path &rToPath)

Detailed Description

Helper methods for creating and copying filesystem entries with Chaste's standard output permissions.

Definition at line 47 of file FilesystemPermissions.hpp.

Member Function Documentation

CopyFileWithPermissions()

static void FilesystemPermissions::CopyFileWithPermissions ( const fs::path &  rFromPath, const fs::path &  rToPath  )

inlinestatic

Copy a file and set standard Chaste file permissions on the destination.

Parameters

rFromPath	source file
rToPath	destination file

Definition at line 141 of file FilesystemPermissions.hpp.

References SetFilePermissions().

Referenced by OutputFileHandler::CopyFileTo().

CreateDirectoriesWithPermissions()

static bool FilesystemPermissions::CreateDirectoriesWithPermissions ( const fs::path &  rPath )

inlinestatic

Create directories and set standard Chaste directory permissions on each directory that is created.

Parameters

rPath

path to create

Returns

true if any directory was created

Definition at line 118 of file FilesystemPermissions.hpp.

References CreateDirectoriesWithPermissions(), and CreateDirectoryWithPermissions().

Referenced by CreateDirectoriesWithPermissions(), and OutputFileHandler::MakeFoldersAndReturnFullPath().

CreateDirectoryWithPermissions()

static bool FilesystemPermissions::CreateDirectoryWithPermissions ( const fs::path &  rPath )

inlinestatic

Create a directory and set standard Chaste directory permissions if it was created.

Parameters

rPath

path to create

Returns

true if the directory was created

Definition at line 101 of file FilesystemPermissions.hpp.

References SetDirectoryPermissions().

Referenced by CreateDirectoriesWithPermissions(), and OutputFileHandler::MakeFoldersAndReturnFullPath().

GetDirectoryPermissions()

static fs::perms FilesystemPermissions::GetDirectoryPermissions ( )

inlinestatic

Returns

standard Chaste permissions for created directories.

Definition at line 61 of file FilesystemPermissions.hpp.

Referenced by SetDirectoryPermissions().

GetFilePermissions()

static fs::perms FilesystemPermissions::GetFilePermissions ( )

inlinestatic

Returns

standard Chaste permissions for created files.

Definition at line 53 of file FilesystemPermissions.hpp.

Referenced by SetFilePermissions().

SetDirectoryPermissions()

static void FilesystemPermissions::SetDirectoryPermissions ( const fs::path &  rPath )

inlinestatic

Set standard Chaste directory permissions.

Parameters

rPath

path to a directory

Definition at line 87 of file FilesystemPermissions.hpp.

References GetDirectoryPermissions().

Referenced by CreateDirectoryWithPermissions().

SetFilePermissions()

static void FilesystemPermissions::SetFilePermissions ( const fs::path &  rPath )

inlinestatic

Set standard Chaste file permissions.

Parameters

rPath

path to a file

Definition at line 72 of file FilesystemPermissions.hpp.

References GetFilePermissions().

Referenced by ArchiveOpener< OutputArchive, std::ofstream >::ArchiveOpener(), CopyFileWithPermissions(), OutputFileHandler::MakeFoldersAndReturnFullPath(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::OpenElementFiles(), OutputFileHandler::OpenOutputFile(), Citations::Print(), and HeartConfig::Write().

---

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

• global/src/FilesystemPermissions.hpp