Dokumentacja klasy common::MemoryStream
[Moduł Stream]

Strumień pamięci statycznej. Więcej...

#include <Stream.hpp>

Diagram dziedziczenia dla common::MemoryStream

Lista wszystkich składowych.

Metody publiczne
	MemoryStream (size_t Size, void *Data=0)
virtual	~MemoryStream ()
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.
char *	Data ()

---

Opis szczegółowy

Strumień pamięci statycznej.

Strumień ma stałą długość i nie może być rozszerzany - ani automatycznie, ani ręcznie.

---

Dokumentacja konstruktora i destruktora

common::MemoryStream::MemoryStream	(	size_t	Size,
		void *	Data = 0
	)

Parametry:

Data

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

virtual common::MemoryStream::~MemoryStream

(

)

[virtual]

---

Dokumentacja funkcji składowych

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

Zapisuje dane.

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

Reimplementowana z common::Stream.

virtual size_t common::MemoryStream::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::MemoryStream::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::MemoryStream::GetSize

(

)

[virtual]

Zwraca rozmiar.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual int common::MemoryStream::GetPos

(

)

[virtual]

Zwraca pozycję względem początku.

W oryginale: zgłasza błąd.

Reimplementowana z common::SeekableStream.

virtual void common::MemoryStream::SetPos

(

int

pos

)

[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::MemoryStream::Rewind

(

)

[virtual]

Ustawia pozycję na początku.

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

Reimplementowana z common::SeekableStream.

char* common::MemoryStream::Data

(

)

[inline]

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Stream.hpp