PLCnext API Documentation  22.9.0.33
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Arp::System::Commons::Io::Stream Class Referenceabstract

Provides a generic view of a sequence of bytes. More...

#include <Stream.hpp>

Inheritance diagram for Arp::System::Commons::Io::Stream:
Inheritance graph

Public Member Functions

 Stream (void)
 Constructs an Stream instance. More...
 
 Stream (const Stream &arg)=delete
 Copy constructor. More...
 
Streamoperator= (const Stream &arg)=delete
 Assignment operator. More...
 
virtual ~Stream (void)
 Destructs this instance and frees all resources. More...
 
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
 
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)
 
void Dispose (void)
 
void Close (void)
 

Static Public Attributes

static NullStream Empty
 

Protected Member Functions

boolean IsDisposed (void)
 
void CheckDisposed (void)
 
virtual void InternalDispose (void)=0
 

Detailed Description

Provides a generic view of a sequence of bytes.

Constructor & Destructor Documentation

◆ Stream() [1/2]

Arp::System::Commons::Io::Stream::Stream ( void  )
inline

Constructs an Stream instance.

◆ Stream() [2/2]

Arp::System::Commons::Io::Stream::Stream ( const Stream arg)
delete

Copy constructor.

◆ ~Stream()

Arp::System::Commons::Io::Stream::~Stream ( void  )
inlinevirtual

Destructs this instance and frees all resources.

Member Function Documentation

◆ operator=()

Stream& Arp::System::Commons::Io::Stream::operator= ( const Stream arg)
delete

Assignment operator.


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