ppl7::PFPChunk Klassenreferenz

Daten-Chunk eines PFP-File Version 3. Mehr ...

Öffentliche Methoden
	PFPChunk ()
	Konstruktor des PFPChunk. Mehr ...
	~PFPChunk ()
	Destruktor des PFPChunk. Mehr ...
const void *	data ()
	Pointer auf die Daten des Chunks holen. Mehr ...
const String &	name ()
	Name des Chunks auslesen. Mehr ...
void	setData (const void *ptr, size_t size)
	Nutzdaten des Chunks setzen. Mehr ...
void	setData (const ByteArrayPtr &data)
	Nutzdaten des Chunks setzen. Mehr ...
void	setData (const String &s)
	String als Nutzdaten des Chunks setzen. Mehr ...
void	setData (const char *s)
	String als Nutzdaten des Chunks setzen. Mehr ...
void	setName (const String &chunkname)
	Name des Chunks setzen. Mehr ...
size_t	size ()
	Größe des Chunks auslesen. Mehr ...

Private Attribute
void *	chunkdata
String	chunkname
size_t	chunksize

Freundbeziehungen
class	PFPFile

Ausführliche Beschreibung

Beschreibung:

In dieser Klasse werden die Daten eines einzelnen Chunks eines PFP-Files Version 3 gespeichert. Um einen Chunk zu erstellen, wird mit "new" eine neue Instanz der Klasse generiert und mit der Funktion PFPFile::addChunk einem PFP-File hinzugefügt. Um einen existierenden Chunk zu löschen, muß die Funktion PFPFile::deleteChunk aufgerufen werden.

Siehe auch

PFPFile

Beschreibung der Konstruktoren und Destruktoren

ppl7::PFPChunk::PFPChunk

(

)

Beschreibung:

Der Konstruktor initialisiert den Datenbereich mit NULL und setzt als Name "UNKN" ein. Ein derartiger Chunk würde durch die PFPFile-Klasse nicht gespeichert.

ppl7::PFPChunk::~PFPChunk

(

)

Beschreibung:

Der Destruktor sorgt dafür, dass der Datenbereich des Chunks freigegeben wird, sofern er definiert wurde, und wenn er einem PFPFile zugeordnet wurde, wird er daraus entfernt.

Dokumentation der Elementfunktionen

const void * ppl7::PFPChunk::data

(

)

Beschreibung:

Mit dieser Funktion wir der Pointer auf die Nutzdaten des Chunks ausgelesen.

Rückgabe

Enthält der Chunk Daten, wird ein Pointer darauf zurückgegeben. Wenn nicht, wird NULL zurückgegeben.

const String & ppl7::PFPChunk::name

(

)

Beschreibung:

Diese Funktion liefert den Namen des Chunks zurück. Dieser ist immer 4 Byte groß.

Rückgabe

String mit dem Namen des Chunks.

void ppl7::PFPChunk::setData	(	const void *	ptr,
		size_t	size
	)

Beschreibung:

Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.

Parameter

ptr	Ein Pointer auf den Beginn der Daten
size	Größe der Daten in Byte. Ein Chunk darf maximal 2^32 - 9 Bytes groß sein

Ausnahmebehandlung

NullPointerException	Wird geworfen, wenn ptr auf NULL zeigt
OutOfMemoryException	Nicht genug Speicher
IllegalArgumentException	Der Parameter size ist zu groß

void ppl7::PFPChunk::setData

(

const ByteArrayPtr &

data

)

Beschreibung:

Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.

Parameter

data	Eine Referenz aif ein ByteArray oder ByteArrayPtr

Ausnahmebehandlung

NullPointerException	Wird geworfen, wenn ptr auf NULL zeigt
OutOfMemoryException	Nicht genug Speicher

void ppl7::PFPChunk::setData

(

const String &

s

)

Beschreibung:

Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.

Parameter

s	Ein String, dessen Inhalt als Nutzdaten übernommen werden soll. Der String wird dazu in das lokale 8-Bit-Format des Systems konvertiert.

Ausnahmebehandlung

OutOfMemoryException	Nicht genug Speicher
IllegalArgumentException	Der String ist zu groß
CharacterEncodingException	Der String konnte nicht konvertiert werden

void ppl7::PFPChunk::setData

(

const char *

s

)

Beschreibung:

Mit dieser Funktion werden die Nutzdaten des Chunks angegeben. Die Daten werden dabei in einen eigenen Speicherbereich kopiert.

Parameter

s	Pointer auf einen 0-Terminierten String, der als Nutzdaten übernommen werden soll.

Ausnahmebehandlung

NullPointerException	Wird geworfen, wenn der Parameter s auf NULL zeigt
OutOfMemoryException	Nicht genug Speicher
IllegalArgumentException	Der String ist zu groß

void ppl7::PFPChunk::setName

(

const String &

chunkname

)

Beschreibung:

Mit dieser Funktion wird der Name eines Chunks definiert. Der Name muss exakt 4 Byte lang sein und darf nur Großbuchstaben enthalten (es wird eine automatische Konvertierung durchgeführt). Ausserdem sind nur Zeichen aus dem Zeichensatz US-ASCII erlaubt.

Parameter

chunkname

String mit dem Namen des Strings

Ausnahmebehandlung

IllegalArgumentException

Wird geworfen, wenn der Name des Chunks ungültig ist

size_t ppl7::PFPChunk::size

(

)

Beschreibung:

Mit dieser Funktion kann die Größe des Chunks ausgelesen werden.

Rückgabe

Enthält der Chunk Daten, wird die Anzahl Bytes zurückgegeben. Ist er leer, wird 0 zurückgegeben und der Fehlercode 424 gesetzt.

Freundbeziehungen und Funktionsdokumentation

friend class PFPFile

friend

Dokumentation der Datenelemente

void* ppl7::PFPChunk::chunkdata

private

String ppl7::PFPChunk::chunkname

private

size_t ppl7::PFPChunk::chunksize

private

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• /jenkins/jobs/clang_ppl7/workspace/include/ppl7.h
• /jenkins/jobs/clang_ppl7/workspace/src/core/PFPFile.cpp