IODevice.h

Go to the documentation of this file.

// %flair:license{
// This file is part of the Flair framework distributed under the
// CECILL-C License, Version 1.0.
// %flair:license}
// ---
#ifndef IO_DEVICE_H
#define IO_DEVICE_H

#include <Object.h>

class IODevice_impl;
class Thread_impl;
class FrameworkManager_impl;

namespace flair {
namespace core {

class io_data;
class DataType;

class IODevice : public Object {
  friend class ::IODevice_impl;
  friend class ::Thread_impl;
  friend class ::FrameworkManager_impl;

public:
  IODevice(const Object *parent, std::string name);

  virtual ~IODevice();

  void AddDeviceToLog(const IODevice *device);

  void AddDataToLog(const io_data *data);

  void OutputToShMem(bool enabled);
  
  bool IsReady(void) const;

  // TODO: these 2 method should be pure virtual
  virtual DataType const &GetInputDataType() const;
  virtual DataType const &GetOutputDataType() const;

  protected:
    void ProcessUpdate(io_data* data);
    
    void SetIsReady(bool status);

  virtual void UpdateFrom(const io_data *data) = 0;

  private:
  class IODevice_impl *pimpl_;
};

} // end namespace core
} // end namespace flair

#endif // IO_DEVICE_H