file.hpp

Go to the documentation of this file.

#pragma once
#ifndef _QICORE_FILE_HPP_
#define _QICORE_FILE_HPP_
/*
**  Copyright (C) 2013 Aldebaran Robotics
**  See COPYING for the license
*/
 
#include <iosfwd>
#include <cassert>
 
#include <qicore/api.hpp>
#include <qi/anyobject.hpp>
#include <qi/path.hpp>
#include <qi/future.hpp>
#include <qi/buffer.hpp>
#include <qi/property.hpp>
 
#include <boost/shared_ptr.hpp>
 
namespace qi
{
class QICORE_API ProgressNotifier
{
protected:
  ProgressNotifier() = default;
 
public:
  virtual ~ProgressNotifier() = default;
 
  enum Status
  {
    Status_Idle,      
    Status_Running,   
    Status_Finished,  
    Status_Failed,    
    Status_Canceled,  
  };
 
  Property<Status> status;
 
  Property<double> progress;
  virtual bool isRunning() const = 0;
 
  virtual Future<void> waitForFinished() = 0;
 
  // The following operations are reserved for the implementation of the associated operations.
 
  virtual void reset() = 0;
 
  virtual void notifyRunning() = 0;
 
  virtual void notifyFinished() = 0;
 
  virtual void notifyCanceled() = 0;
 
  virtual void notifyFailed() = 0;
 
  virtual void notifyProgressed(double newProgress) = 0;
 
  QI_API_DEPRECATED_MSG(Use 'reset' instead) virtual void _reset() = 0;
  QI_API_DEPRECATED_MSG(Use 'notifyRunning' instead) virtual void _notifyRunning() = 0;
  QI_API_DEPRECATED_MSG(Use 'notifyFinished' instead) virtual void _notifyFinished() = 0;
  QI_API_DEPRECATED_MSG(Use 'notifyCanceled' instead) virtual void _notifyCanceled() = 0;
  QI_API_DEPRECATED_MSG(Use 'notifyFailed' instead) virtual void _notifyFailed() = 0;
  QI_API_DEPRECATED_MSG(Use 'notifyProgressed' instead) virtual void _notifyProgressed(double newProgress) = 0;
};
 
using ProgressNotifierPtr = qi::Object<ProgressNotifier>;
 
QICORE_API ProgressNotifierPtr createProgressNotifier(Future<void> operationFuture = {});
 
class QICORE_API File
{
protected:
  File() = default;
 
public:
  virtual ~File() = default;
 
 
  virtual std::streamsize size() const = 0;
 
  virtual bool isOpen() const = 0;
 
  virtual bool isRemote() const = 0;
 
  virtual ProgressNotifierPtr operationProgress() const = 0;
 
  // The following operations are reserved for the implementation of file processing algorithms.
 
  static const std::streamsize MAX_READ_SIZE = 1000000;
 
  virtual Buffer read(std::streamsize countBytesToRead) = 0;
 
  virtual Buffer read(std::streamoff beginOffset, std::streamsize countBytesToRead) = 0;
 
  virtual bool seek(std::streamoff offsetFromBegin) = 0;
 
  virtual void close() = 0;
 
  QI_API_DEPRECATED_MSG(Use 'read' instead) virtual Buffer _read(std::streamsize countBytesToRead) = 0;
  QI_API_DEPRECATED_MSG(Use 'read' instead) virtual Buffer _read(std::streamoff beginOffset, std::streamsize countBytesToRead) = 0;
  QI_API_DEPRECATED_MSG(Use 'seek' instead) virtual bool _seek(std::streamoff offsetFromBegin) = 0;
  QI_API_DEPRECATED_MSG(Use 'close' instead) virtual void _close() = 0;
};
 
using FilePtr = qi::Object<File>;
 
QICORE_API FilePtr openLocalFile(const qi::Path& localPath);
 
}
 
QI_TYPE_INTERFACE(File);
QI_TYPE_INTERFACE(ProgressNotifier);
QI_TYPE_ENUM(ProgressNotifier::Status);
 
#include <qicore/detail/fileoperation.hxx>
 
#endif // _QI_FILE_HPP_