Stream.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Io/SeekOrigin.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Io
{
 
// forwards
class NullStream;
 
class Stream
{
public: // construction/destruction
    Stream(void);
    Stream(const Stream& arg) = delete;
    Stream& operator=(const Stream& arg) = delete;
    virtual ~Stream(void);
 
public: // static properties
    static NullStream Empty;
 
public: // setter/getter operations
    virtual boolean CanRead(void) = 0;
    virtual boolean CanWrite(void) = 0;
    virtual boolean CanSeek(void) = 0;
    virtual size_t  GetLength(void) = 0;
    virtual void    SetLength(size_t length) = 0;
    virtual size_t  GetPosition(void) = 0;
    virtual void    SetPosition(size_t position) = 0;
 
public: // virutal operations
    virtual void    Flush(void) = 0;
    virtual size_t  Seek(size_t offset, SeekOrigin origin) = 0;
    virtual size_t  Read(byte* pBuffer, size_t bufferSize, size_t offset, size_t count) = 0;
    virtual void    Write(const byte* pBuffer, size_t bufferSize, size_t offset, size_t count) = 0;
    virtual byte    ReadByte(void);
    virtual void    WriteByte(byte value);
    virtual void    CopyTo(Stream& other);
 
public: // operations
    void    Dispose(void);
    void    Close(void);
 
protected: // operations
    boolean     IsDisposed(void);
    void        CheckDisposed(void);
    virtual void InternalDispose(void) = 0;
 
private: // fields
    bool isDisposed;
};
 
// inline methods of class Stream
 
inline Stream::Stream(void)
    : isDisposed(false)
{
}
 
inline Stream::~Stream(void)
{
}
 
inline boolean Stream::IsDisposed(void)
{
    return this->isDisposed;
}
 
}}}} // end of namespace Arp::System::Commons::Io