PLCnext API Documentation  21.6.0.46
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Commons::Services::Io::IFileSystemInfoService Class Referenceabstract

A generic service to retrieve file system infos. More...

#include <IFileSystemInfoService.hpp>

Inheritance diagram for Arp::System::Commons::Services::Io::IFileSystemInfoService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IFileSystemInfoService >
 
using GetRootDirectoriesResultDelegate = delegate< void(IRscReadEnumerator< RscString< 512 > > &)>
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IFileSystemInfoService (void)=default
 Constructs an IFileSystemInfoService instance. More...
 
virtual Traits GetSupportedTraits ()=0
 Gets the supported traits. More...
 
virtual FileSystemError GetPermissions (const RscString< 512 > &path, Permissions &permissions)=0
 Gets the permissions of the specified path. More...
 
virtual FileSystemError AddPermissions (const RscString< 512 > &path, Permissions permissions)=0
 Adds the permissions to the specified path. More...
 
virtual FileSystemError RemovePermissions (const RscString< 512 > &path, Permissions permissions)=0
 Removes the permissions of the specified path. More...
 
virtual FileSystemError GetFileSystemTraitsEntry (Traits traits, const RscString< 512 > &path, FileSystemTraitsEntry &fileSystemTraitsEntry)=0
 Gets the file system traits entry of the specified path. More...
 
virtual FileSystemError GetSpaceInfo (const RscString< 512 > &path, SpaceInfo &spaceInfo)=0
 Gets the space information of the specified path. More...
 
virtual void GetRootDirectories (GetRootDirectoriesResultDelegate resultDelegate)=0
 Gets a list of all root directories supported by the target. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

A generic service to retrieve file system infos.

The path separator is always '/'.

Constructor & Destructor Documentation

◆ IFileSystemInfoService()

Arp::System::Commons::Services::Io::IFileSystemInfoService::IFileSystemInfoService ( void  )
default

Constructs an IFileSystemInfoService instance.

Member Function Documentation

◆ AddPermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::AddPermissions ( const RscString< 512 > &  path,
Permissions  permissions 
)
pure virtual

Adds the permissions to the specified path.

Parameters
pathThe path to add the permissions from.
permissionsThe permissions to add.
Returns
Result of the action.

◆ GetFileSystemTraitsEntry()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetFileSystemTraitsEntry ( Traits  traits,
const RscString< 512 > &  path,
FileSystemTraitsEntry fileSystemTraitsEntry 
)
pure virtual

Gets the file system traits entry of the specified path.

Parameters
traitsThe selection of traits to get.
pathThe path to get the file system traits entry from.
fileSystemTraitsEntryThe file system traits entry of the specified path
Returns
Result of the action.

◆ GetPermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetPermissions ( const RscString< 512 > &  path,
Permissions permissions 
)
pure virtual

Gets the permissions of the specified path.

Parameters
pathThe path to get the permissions from.
permissionsThe permissions of the specified path.
Returns
Result of the action.

◆ GetRootDirectories()

virtual void Arp::System::Commons::Services::Io::IFileSystemInfoService::GetRootDirectories ( GetRootDirectoriesResultDelegate  resultDelegate)
pure virtual

Gets a list of all root directories supported by the target.

Returns
A list of list of all root directories.

◆ GetSpaceInfo()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::GetSpaceInfo ( const RscString< 512 > &  path,
SpaceInfo spaceInfo 
)
pure virtual

Gets the space information of the specified path.

Parameters
pathThe path to get the space information from.
spaceInfoThe space information of the specified path.
Returns
Result of the action.

◆ GetSupportedTraits()

virtual Traits Arp::System::Commons::Services::Io::IFileSystemInfoService::GetSupportedTraits ( )
pure virtual

Gets the supported traits.

Returns
The supported traits as bitset.

◆ RemovePermissions()

virtual FileSystemError Arp::System::Commons::Services::Io::IFileSystemInfoService::RemovePermissions ( const RscString< 512 > &  path,
Permissions  permissions 
)
pure virtual

Removes the permissions of the specified path.

Parameters
pathThe path to remove the permissions from.
permissionsThe permissions to remove.
Returns
Result of the action.

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