Dokumentacja klasy common::StringStream
[Moduł Stream]

Strumień oparty na łańcuchu std::string. Więcej...

#include <Stream.hpp>

Diagram dziedziczenia dla common::StringStream

Lista wszystkich składowych.

Metody publiczne
	StringStream (string *Data=0)
virtual	~StringStream ()
virtual void	Write (const void *Data, size_t Size)
	Zapisuje dane.
virtual size_t	Read (void *Data, size_t Size)
	Odczytuje dane.
virtual void	MustRead (void *Data, size_t Size)
	Odczytuje tyle bajtów, ile się zażąda.
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	Rewind ()
	Ustawia pozycję na początku.
virtual void	SetSize (size_t Size)
	Ustawia rozmiar na podany.
virtual void	Clear ()
	Opróżnia strumień.
size_t	GetCapacity ()
void	SetCapacity (size_t Capacity)
string *	Data ()

---

Opis szczegółowy

Strumień oparty na łańcuchu std::string.

Potrafi się rozszerzać.

---

Dokumentacja konstruktora i destruktora

common::StringStream::StringStream

(

string *

Data = 0

)

Parametry:

Data

Podaj NULL, aby strumień sam zaalokował, a w destruktorze zwolnił łańcuch. Podaj wskaźnik, jeśli ma korzystać z twojego obszaru pamięci.

virtual common::StringStream::~StringStream

(

)

[virtual]

---

Dokumentacja funkcji składowych

virtual void common::StringStream::Write	(	const void *	Data,
		size_t	Size
	)			[virtual]

Zapisuje dane.

(W oryginale: zgłasza błąd)

Reimplementowana z common::Stream.

virtual size_t common::StringStream::Read	(	void *	Data,
		size_t	MaxLength
	)			[virtual]

Odczytuje dane.

Jeśli osiągnięto koniec, funkcja nie zwraca błędu, a liczba odczytanych bajtów to 0. (W oryginale: zgłasza błąd)

Parametry:

Size

Liczba bajtów do odczytania

Zwraca:

Zwraca liczbę bajtów, jakie udało się odczytać

Reimplementowana z common::Stream.

virtual void common::StringStream::MustRead	(	void *	Data,
		size_t	Length
	)			[virtual]

Odczytuje tyle bajtów, ile się zażąda.

Jeśli koniec pliku albo jeśli odczytano mniej, zgłasza błąd. (Można ją przeładować, ale nie trzeba - ma swoją wersję oryginalną)

Reimplementowana z common::Stream.

virtual size_t common::StringStream::GetSize

(

)

[inline, virtual]

Zwraca rozmiar.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual int common::StringStream::GetPos

(

)

[inline, virtual]

Zwraca pozycję względem początku.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual void common::StringStream::SetPos

(

int

pos

)

[inline, virtual]

Ustawia pozycję względem początku.

W oryginale: zgłasza błąd.

Parametry:

pos

Musi być dodatnie.

Reimplementowana z common::SeekableStream.

virtual void common::StringStream::Rewind

(

)

[inline, virtual]

Ustawia pozycję na początku.

Można ją nadpisać, ale ma wersję oryginalną.

Reimplementowana z common::SeekableStream.

virtual void common::StringStream::SetSize

(

size_t

Size

)

[inline, virtual]

Ustawia rozmiar na podany.

Po tym wywołaniu pozycja kursora jest niezdefiniowana. W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual void common::StringStream::Clear

(

)

[inline, virtual]

Opróżnia strumień.

Można ją nadpisać, ale ma wersję oryginalną.

Reimplementowana z common::SeekableStream.

size_t common::StringStream::GetCapacity

(

)

[inline]

void common::StringStream::SetCapacity

(

size_t

Capacity

)

[inline]

string* common::StringStream::Data

(

)

[inline]

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Stream.hpp