PLCnext API Documentation 23.0.2.9
IFileSystemInfoService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/System/Commons/Services/Io/FileSystemError.hpp"
9#include "Arp/System/Commons/Services/Io/FileSystemInfoServiceProxyFactory.hpp"
10#include "Arp/System/Commons/Services/Io/FileSystemTraitsEntry.hpp"
11#include "Arp/System/Commons/Services/Io/Permissions.hpp"
12#include "Arp/System/Commons/Services/Io/SpaceInfo.hpp"
13#include "Arp/System/Commons/Services/Io/Traits.hpp"
14#include "Arp/System/Core/delegate.hxx"
15#include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
16#include "Arp/System/Rsc/Services/IRscService.hpp"
17#include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
18#include "Arp/System/Rsc/Services/RscString.hxx"
19
20// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IFileSystemInfoService.cs
21
22namespace Arp { namespace System { namespace Commons { namespace Services { namespace Io
23{
24
25using namespace Arp;
26using namespace Arp::System::Rsc::Services;
27
34{
35public: // typedefs
36 using Ptr = std::shared_ptr<IFileSystemInfoService>;
37 using GetRootDirectoriesResultDelegate = delegate<void(IRscReadEnumerator<RscString<512>>&)>;
38
39public: // construction/destruction
41 IFileSystemInfoService(void) = default;
42
43public: // static policy operation
44 static IRscServiceProxyFactory& GetProxyFactory(void);
45
46public: // abstract operations
52
61 virtual FileSystemError GetPermissions(const RscString<512>& path, Permissions& permissions) = 0;
62
71 virtual FileSystemError AddPermissions(const RscString<512>& path, Permissions permissions) = 0;
72
81 virtual FileSystemError RemovePermissions(const RscString<512>& path, Permissions permissions) = 0;
82
92 virtual FileSystemError GetFileSystemTraitsEntry(Traits traits, const RscString<512>& path, FileSystemTraitsEntry& fileSystemTraitsEntry) = 0;
93
102 virtual FileSystemError GetSpaceInfo(const RscString<512>& path, SpaceInfo& spaceInfo) = 0;
103
110 virtual void GetRootDirectories(GetRootDirectoriesResultDelegate resultDelegate) = 0;
111};
112
114// inline methods of class IFileSystemInfoService
115inline IRscServiceProxyFactory& IFileSystemInfoService::GetProxyFactory()
116{
117 return FileSystemInfoServiceProxyFactory::GetInstance();
118}
119
120}}}}} // end of namespace Arp::System::Commons::Services::Io
This struct is used by file operations reading file informations from device.
Definition: FileSystemTraitsEntry.hpp:29
A generic service to retrieve file system infos.
Definition: IFileSystemInfoService.hpp:34
virtual FileSystemError GetFileSystemTraitsEntry(Traits traits, const RscString< 512 > &path, FileSystemTraitsEntry &fileSystemTraitsEntry)=0
Gets the file system traits entry of the specified path.
IFileSystemInfoService(void)=default
Constructs an IFileSystemInfoService instance.
virtual FileSystemError GetSpaceInfo(const RscString< 512 > &path, SpaceInfo &spaceInfo)=0
Gets the space information of the specified path.
virtual FileSystemError AddPermissions(const RscString< 512 > &path, Permissions permissions)=0
Adds the permissions to the specified path.
virtual void GetRootDirectories(GetRootDirectoriesResultDelegate resultDelegate)=0
Gets a list of all root directories supported by the target.
virtual Traits GetSupportedTraits()=0
Gets the supported traits.
virtual FileSystemError RemovePermissions(const RscString< 512 > &path, Permissions permissions)=0
Removes the permissions of the specified path.
virtual FileSystemError GetPermissions(const RscString< 512 > &path, Permissions &permissions)=0
Gets the permissions of the specified path.
This struct is used by file operations to reading of the space informations.
Definition: SpaceInfo.hpp:25
Interface for reading an array or an enumerator. For regular enumerators UndefinedArrayLength is used...
Definition: IRscReadEnumerator.hxx:21
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
@ System
System components used by the System, Device, Plc or Io domains.
Permissions
Provides attributes for files and directories.
Definition: Permissions.hpp:19
Traits
This enum is used by several file services to specify the file traits to get or set,...
Definition: Traits.hpp:19
FileSystemError
This enum is used by several file operations.
Definition: FileSystemError.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API