PLCnext API Documentation 24.0.0.71
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.
 
 Stream (const Stream &arg)=delete
 Copy constructor.
 
Streamoperator= (const Stream &arg)=delete
 Assignment operator.
 
virtual ~Stream (void)
 Destructs this instance and frees all resources.
 
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.

Member Function Documentation

◆ CanRead()

virtual boolean Arp::System::Commons::Io::Stream::CanRead ( void  )
pure virtual

◆ CanSeek()

virtual boolean Arp::System::Commons::Io::Stream::CanSeek ( void  )
pure virtual

◆ CanWrite()

virtual boolean Arp::System::Commons::Io::Stream::CanWrite ( void  )
pure virtual

◆ Flush()

virtual void Arp::System::Commons::Io::Stream::Flush ( void  )
pure virtual

◆ GetLength()

virtual size_t Arp::System::Commons::Io::Stream::GetLength ( void  )
pure virtual

◆ GetPosition()

virtual size_t Arp::System::Commons::Io::Stream::GetPosition ( void  )
pure virtual

◆ Read()

virtual size_t Arp::System::Commons::Io::Stream::Read ( byte pBuffer,
size_t  bufferSize,
size_t  offset,
size_t  count 
)
pure virtual

◆ Seek()

virtual size_t Arp::System::Commons::Io::Stream::Seek ( size_t  offset,
SeekOrigin  origin 
)
pure virtual

◆ SetLength()

virtual void Arp::System::Commons::Io::Stream::SetLength ( size_t  length)
pure virtual

◆ SetPosition()

virtual void Arp::System::Commons::Io::Stream::SetPosition ( size_t  position)
pure virtual

◆ Write()

virtual void Arp::System::Commons::Io::Stream::Write ( const byte pBuffer,
size_t  bufferSize,
size_t  offset,
size_t  count 
)
pure virtual

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