Dokumentacja klasy common::SeekableStream
[Moduł Stream]
Abstrakcyjna klasa bazowa strumieni pozwalających na odczytywanie rozmiaru i zmianę pozycji.
Więcej...
#include <Stream.hpp>
Metody publiczne | |
| virtual bool | End () |
| virtual size_t | Skip (size_t MaxLength) |
| virtual size_t | GetSize () |
| Zwraca rozmiar. | |
| virtual int | GetPos () |
| Zwraca pozycję względem początku. | |
| virtual void | SetPos (int pos) |
| Ustawia pozycję względem początku. | |
| virtual void | SetPosFromCurrent (int pos) |
| Ustawia pozycję względem bieżącej. | |
| virtual void | SetPosFromEnd (int pos) |
| Ustawia pozycję względem końcowej. | |
| virtual void | Rewind () |
| Ustawia pozycję na początku. | |
| virtual void | SetSize (size_t Size) |
| Ustawia rozmiar na podany. | |
| virtual void | Truncate () |
| Obcina strumień od bieżącej pozycji do końca, czyli ustawia taki rozmiar jak bieżąca pozycja. | |
| virtual void | Clear () |
| Opróżnia strumień. | |
Opis szczegółowy
Abstrakcyjna klasa bazowa strumieni pozwalających na odczytywanie rozmiaru i zmianę pozycji.Dokumentacja funkcji składowych
| virtual bool common::SeekableStream::End | ( | ) | [virtual] |
W Stream domyślnie rzuca błąd, tu w SeekableStream dostaje już wersję oryginalną. Można ją dalej nadpisać.
Reimplementowana z common::Stream.
Reimplementowana w common::FileStream.
| virtual size_t common::SeekableStream::Skip | ( | size_t | MaxLength | ) | [virtual] |
W Stream ma wersję oryginalną, tu w SeekableStream dostaje lepszą. Można ją dalej nadpisać.
Reimplementowana z common::Stream.
| virtual size_t common::SeekableStream::GetSize | ( | ) | [virtual] |
Zwraca rozmiar.
W oryginale: zgłasza błąd.
Reimplementowana w common::FileStream, common::MemoryStream, common::VectorStream i common::StringStream.
| virtual int common::SeekableStream::GetPos | ( | ) | [virtual] |
Zwraca pozycję względem początku.
W oryginale: zgłasza błąd.
Reimplementowana w common::FileStream, common::MemoryStream, common::VectorStream i common::StringStream.
| virtual void common::SeekableStream::SetPos | ( | int | pos | ) | [virtual] |
Ustawia pozycję względem początku.
W oryginale: zgłasza błąd.
- Parametry:
-
pos Musi być dodatnie.
Reimplementowana w common::FileStream, common::MemoryStream, common::VectorStream i common::StringStream.
| virtual void common::SeekableStream::SetPosFromCurrent | ( | int | pos | ) | [virtual] |
Ustawia pozycję względem bieżącej.
Można ją nadpisać, ale ma wersję oryginalną
- Parametry:
-
pos może być dodatnie albo ujemne.
Reimplementowana w common::FileStream.
| virtual void common::SeekableStream::SetPosFromEnd | ( | int | pos | ) | [virtual] |
Ustawia pozycję względem końcowej.
Można ją nadpisać, ale ma wersję oryginalną. Np. abu ustawić na ostatni znak, przesuń do -1.
Reimplementowana w common::FileStream.
| virtual void common::SeekableStream::Rewind | ( | ) | [virtual] |
Ustawia pozycję na początku.
Można ją nadpisać, ale ma wersję oryginalną.
Reimplementowana w common::MemoryStream, common::VectorStream i common::StringStream.
| virtual void common::SeekableStream::SetSize | ( | size_t | Size | ) | [virtual] |
Ustawia rozmiar na podany.
Po tym wywołaniu pozycja kursora jest niezdefiniowana. W oryginale: zgłasza błąd.
Reimplementowana w common::FileStream, common::VectorStream i common::StringStream.
| virtual void common::SeekableStream::Truncate | ( | ) | [virtual] |
Obcina strumień od bieżącej pozycji do końca, czyli ustawia taki rozmiar jak bieżąca pozycja.
Można ją nadpisać, ale ma wersję oryginalną.
Reimplementowana w common::FileStream.
| virtual void common::SeekableStream::Clear | ( | ) | [virtual] |
Opróżnia strumień.
Można ją nadpisać, ale ma wersję oryginalną.
Reimplementowana w common::StringStream.
Dokumentacja dla tej klasy została wygenerowana z pliku:
