PLCnext API Documentation  21.6.0.46
IFileSystemInfoService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "FileSystemInfoServiceProxyFactory.hpp"
10 #include "Arp/System/Core/delegate.hxx"
11 #include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
12 #include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
13 #include "Arp/System/Rsc/Services/RscString.hxx"
14 #include "FileSystemError.hpp"
15 #include "FileSystemTraitsEntry.hpp"
16 #include "Permissions.hpp"
17 #include "SpaceInfo.hpp"
18 #include "Traits.hpp"
19 
20 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IFileSystemInfoService.cs
21 
22 namespace Arp { namespace System { namespace Commons { namespace Services { namespace Io
23 {
24 
25 using namespace Arp;
26 using namespace Arp::System::Rsc::Services;
27 
33 {
34 public: // typedefs
35  using Ptr = std::shared_ptr<IFileSystemInfoService>;
36  using GetRootDirectoriesResultDelegate = delegate<void(IRscReadEnumerator<RscString<512>>&)>;
37 
38 public: // construction/destruction
40  IFileSystemInfoService(void) = default;
41 
42 public: // static policy operation
43  static IRscServiceProxyFactory& GetProxyFactory(void);
44 
45 public: // abstract operations
50  virtual Traits GetSupportedTraits() = 0;
51 
60  virtual FileSystemError GetPermissions(const RscString<512>& path, Permissions& permissions) = 0;
61 
70  virtual FileSystemError AddPermissions(const RscString<512>& path, Permissions permissions) = 0;
71 
80  virtual FileSystemError RemovePermissions(const RscString<512>& path, Permissions permissions) = 0;
81 
91  virtual FileSystemError GetFileSystemTraitsEntry(Traits traits, const RscString<512>& path, FileSystemTraitsEntry& fileSystemTraitsEntry) = 0;
92 
101  virtual FileSystemError GetSpaceInfo(const RscString<512>& path, SpaceInfo& spaceInfo) = 0;
102 
109  virtual void GetRootDirectories(GetRootDirectoriesResultDelegate resultDelegate) = 0;
110 };
111 
113 // inline methods of class IFileSystemInfoService
114 inline IRscServiceProxyFactory& IFileSystemInfoService::GetProxyFactory()
115 {
116  return FileSystemInfoServiceProxyFactory::GetInstance();
117 }
118 
119 }}}}} // end of namespace Arp::System::Commons::Services::Io
This struct is used by file operations reading file informations from device.
Definition: FileSystemTraitsEntry.hpp:28
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
Traits
This enum is used by several file services to specify the file traits to get or set, respectively.
Definition: Traits.hpp:20
FileSystemError
This enum is used by several file operations.
Definition: FileSystemError.hpp:20
Permissions
Provides attributes for files and directories.
Definition: Permissions.hpp:20
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
System components used by the System, Device, Plc or Io domains.
This struct is used by file operations to reading of the space informations.
Definition: SpaceInfo.hpp:24
A generic service to retrieve file system infos.
Definition: IFileSystemInfoService.hpp:32