libqicore-api  2.8.7.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Public Member Functions | List of all members
qi::FileCopyToLocal Class Reference

#include <fileoperation.hxx>

Public Member Functions

 FileCopyToLocal (qi::FilePtr file, qi::Path localPath)
 
- Public Member Functions inherited from qi::FileOperation
virtual ~FileOperation ()
 
 FileOperation (const FileOperation &)=delete
 
FileOperationoperator= (const FileOperation &)=delete
 
 FileOperation (FileOperation &&other)
 
FileOperationoperator= (FileOperation &&other)
 
qi::Future< void > start ()
 
qi::Future< void > detach ()
 
auto operator() () -> decltype(start())
 Call operator: calls start() More...
 
ProgressNotifierPtr notifier () const
 
bool isValid () const
 
 operator bool () const
 

Additional Inherited Members

- Protected Types inherited from qi::FileOperation
using TaskPtr = boost::shared_ptr< Task >
 
- Protected Member Functions inherited from qi::FileOperation
 FileOperation (TaskPtr task)
 

Detailed Description

Copies a potentially remote file to the local file system.

Definition at line 208 of file fileoperation.hxx.

Constructor & Destructor Documentation

qi::FileCopyToLocal::FileCopyToLocal ( qi::FilePtr  file,
qi::Path  localPath 
)
inline

Constructor.

Parameters
fileAccess to a potentially remote file to copy to the local file system.
localPathLocal file system location where the specified file will be copied. No file or directory should be located at this path otherwise the operation will fail.

Definition at line 218 of file fileoperation.hxx.


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