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

Provides common file operations for several files in a single call. More...

#include <IFileService2.hpp>

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

Public Types

using Ptr = std::shared_ptr< IFileService2 >
 
using ExistsManyPathsDelegate = delegate< void(IRscWriteEnumerator< RscString< 512 > > &)>
 
using ExistsManyResultDelegate = delegate< void(IRscReadEnumerator< boolean > &)>
 
using WriteManyWriteFileDataDelegate = delegate< void(IRscWriteEnumerator< WriteFileData > &)>
 
using WriteManyResultDelegate = delegate< void(IRscReadEnumerator< FileSystemError > &)>
 
using ReadManyReadFileInfoDelegate = delegate< void(IRscWriteEnumerator< ReadFileInfo > &)>
 
using ReadManyReadFileDataDelegate = delegate< void(IRscReadEnumerator< ReadFileData > &)>
 
using DeleteManyFilePathsDelegate = delegate< void(IRscWriteEnumerator< RscString< 512 > > &)>
 
using DeleteManyResultDelegate = delegate< void(IRscReadEnumerator< FileSystemError > &)>
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IFileService2 (void)=default
 Constructs an IFileService2 instance. More...
 
virtual boolean Exists (const RscString< 512 > &path)=0
 
virtual FileSystemError Write (const RscString< 512 > &filePath, boolean overwrite, const std::vector< TraitItem > &traitItems, RscStreamAdapter data)=0
 
virtual FileSystemError Read (Traits fileTraits, const RscString< 512 > &filePath, RscStreamAdapter data, std::vector< TraitItem > &traitItems)=0
 
virtual FileSystemError Delete (const RscString< 512 > &filePath)=0
 
virtual FileSystemError Move (boolean createDirectory, boolean overwrite, const RscString< 512 > &sourceFilePath, const RscString< 512 > &destinationFilePath)=0
 
virtual FileSystemError Copy (boolean createDirectory, boolean overwrite, const RscString< 512 > &sourceFilePath, const RscString< 512 > &destinationFilePath)=0
 
virtual void ExistsMany (ExistsManyPathsDelegate pathsDelegate, ExistsManyResultDelegate resultDelegate)=0
 Checks if the specified files exist. More...
 
virtual void WriteMany (WriteManyWriteFileDataDelegate writeFileDataDelegate, WriteManyResultDelegate resultDelegate)=0
 Writes the given data to the specified files. More...
 
virtual void ReadMany (ReadManyReadFileInfoDelegate readFileInfoDelegate, ReadManyReadFileDataDelegate readFileDataDelegate)=0
 Reads the specified files. More...
 
virtual void DeleteMany (DeleteManyFilePathsDelegate filePathsDelegate, DeleteManyResultDelegate resultDelegate)=0
 Deletes the specified files. 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

Provides common file operations for several files in a single call.

The path separator is always '/'.

Constructor & Destructor Documentation

◆ IFileService2()

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

Constructs an IFileService2 instance.

Member Function Documentation

◆ DeleteMany()

virtual void Arp::System::Commons::Services::Io::IFileService2::DeleteMany ( DeleteManyFilePathsDelegate  filePathsDelegate,
DeleteManyResultDelegate  resultDelegate 
)
pure virtual

Deletes the specified files.

Parameters
filePathsPaths of files to delete.
Returns
A Arp.System.Commons.Services.Io.FileSystemError array where each element corresponds the related element in filePaths . The element value isArp.System.Commons.Services.Io.FileSystemError.None, if the file could be deleted, otherwise the appropiate error info.

◆ ExistsMany()

virtual void Arp::System::Commons::Services::Io::IFileService2::ExistsMany ( ExistsManyPathsDelegate  pathsDelegate,
ExistsManyResultDelegate  resultDelegate 
)
pure virtual

Checks if the specified files exist.

Parameters
pathsPaths of files to check.
Returns
A bool array where each element corresponds the related element in paths . The element value is true, if the file exists, otherwise false.

◆ ReadMany()

virtual void Arp::System::Commons::Services::Io::IFileService2::ReadMany ( ReadManyReadFileInfoDelegate  readFileInfoDelegate,
ReadManyReadFileDataDelegate  readFileDataDelegate 
)
pure virtual

Reads the specified files.

Parameters
readFileInfoContains information of all files to read.
readFileDataContains the file data and traits of all read files, as well as an eror info if the file could not be read

◆ WriteMany()

virtual void Arp::System::Commons::Services::Io::IFileService2::WriteMany ( WriteManyWriteFileDataDelegate  writeFileDataDelegate,
WriteManyResultDelegate  resultDelegate 
)
pure virtual

Writes the given data to the specified files.

Parameters
writeFileDataAn array of Arp.System.Commons.Services.Io.WriteFileData where ech element contains the file info and data of the file to write.
Returns
A Arp.System.Commons.Services.Io.FileSystemError array where each element corresponds the related element in writeFileData . The element value isArp.System.Commons.Services.Io.FileSystemError.None, if the file could be written, otherwise the appropiate error info.

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