PLCnext API Documentation 26.6.0.38
IDirectoryService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Base/Rsc/Commons/IRscReadEnumerator.hxx"
11#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
12#include "Arp/Base/Core/delegate.hxx"
13#include "Arp/Base/Rsc/Commons/RscString.hxx"
14#include "Arp/System/Commons/Services/Io/FileSystemEntry.hpp"
15#include "Arp/System/Commons/Services/Io/FileSystemError.hpp"
16#include "Arp/System/Commons/Services/Io/FileSystemTraitsEntry.hpp"
17#include "Arp/System/Commons/Services/Io/Traits.hpp"
18
19// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDirectoryService.cs
20
22{
23
24using namespace Arp::Base::Rsc::Commons;
25
40class ARP_EXPORT IDirectoryService : public IRscService
41{
42public: // usings
43 using Ptr = std::shared_ptr<IDirectoryService>;
46
47public: // construction/destruction
49 IDirectoryService(void) = default;
50
51public: // static policy operation
52 static IRscServiceProxyFactory& GetProxyFactory(void);
53
54public: // abstract operations
62 virtual boolean Exists(const RscString<512>& path) = 0;
63
71 virtual FileSystemError Create(const RscString<512>& path) = 0;
72
80 virtual FileSystemError Delete(const RscString<512>& path) = 0;
81
89 virtual FileSystemError Clear(const RscString<512>& path) = 0;
90
102 virtual FileSystemError Move(const RscString<512>& sourcePath, const RscString<512>& destinationPath, boolean clear = false) = 0;
103
115 virtual FileSystemError Copy(const RscString<512>& sourcePath, const RscString<512>& destinationPath, boolean clear = false) = 0;
116
126 virtual void EnumerateFileSystemEntries(const RscString<512>& path, const RscString<512>& searchPattern, boolean recursive, EnumerateFileSystemEntriesResultDelegate resultDelegate) = 0;
127
138 virtual void EnumerateFileSystemTraitsEntries(const RscString<512>& path, const RscString<512>& searchPattern, Traits traits, boolean recursive, EnumerateFileSystemTraitsEntriesResultDelegate resultDelegate) = 0;
139};
140
141} // end of namespace Arp::System::Commons::Services::Io
Prototyping of delegate template.
Definition: delegate.hxx:14
Interface for reading a arrays or enumerations.
Definition: IRscReadEnumerator.hxx:19
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
Provides common file directory operations.
Definition: IDirectoryService.hpp:41
virtual FileSystemError Copy(const RscString< 512 > &sourcePath, const RscString< 512 > &destinationPath, boolean clear=false)=0
Copies the specified directory and its content to the given new location.
IDirectoryService(void)=default
Constructs an IDirectoryService instance.
virtual FileSystemError Create(const RscString< 512 > &path)=0
Creates the specified directory.
virtual FileSystemError Move(const RscString< 512 > &sourcePath, const RscString< 512 > &destinationPath, boolean clear=false)=0
Moves the specified directory and its content to the given new location.
virtual FileSystemError Delete(const RscString< 512 > &path)=0
Deletes the specified directory and its content.
virtual FileSystemError Clear(const RscString< 512 > &path)=0
Removes the content of the specified directory, but does not delete the specified directory itself.
virtual boolean Exists(const RscString< 512 > &path)=0
Checks if the specified directory exists.
virtual void EnumerateFileSystemEntries(const RscString< 512 > &path, const RscString< 512 > &searchPattern, boolean recursive, EnumerateFileSystemEntriesResultDelegate resultDelegate)=0
Enumerates all files and subdirectories of the specified directory.
virtual void EnumerateFileSystemTraitsEntries(const RscString< 512 > &path, const RscString< 512 > &searchPattern, Traits traits, boolean recursive, EnumerateFileSystemTraitsEntriesResultDelegate resultDelegate)=0
Enumerates all files and subdirectories of the specified directory.
Namespace for services to access the filesystem
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