C++ class Util::Serialization::AbstractStreamer
AbstractStreamer

public

Inheritance Graph

graph BT
	AbstractStreamer
	AbstractRenderingStreamer --> AbstractStreamer
	AbstractAudioStreamer --> AbstractStreamer
	AbstractBitmapStreamer --> AbstractStreamer
	click AbstractStreamer "classUtil_1_1Serialization_1_1AbstractStreamer"
	click AbstractRenderingStreamer "classRendering_1_1Serialization_1_1AbstractRenderingStreamer"
	click AbstractAudioStreamer "classSound_1_1AbstractAudioStreamer"
	click AbstractBitmapStreamer "classUtil_1_1Serialization_1_1AbstractBitmapStreamer"

Description

Interface for classes that are capable of converting between objects and streams. Subclasses are allowed to implement only a subset of the functions. Capabilities can be queried.

Author: Benjamin Eikel

Date: 2011-02-03

Public Static Attributes

const uint8_t	CAP_LOAD_GENERIC Streamer supports the functionloadGeneric.
const uint8_t	CAP_SAVE_GENERIC Streamer supports the functionsaveGeneric.

Public Functions

	~AbstractStreamer()
GenericAttributeList *	loadGeneric(std::istream & void)
bool	saveGeneric( GenericAttributeList * void, std::ostream & void)

Public Static Functions

uint8_t	queryCapabilities(const std::string & void)

Protected Functions

	AbstractStreamer() Creation is only possible in subclasses.

---

Documentation

variable
Util::Serialization::AbstractStreamer::CAP_LOAD_GENERIC

public

static

const uint8_t CAP_LOAD_GENERIC

Streamer supports the functionloadGeneric.

_{Defined in Util/Serialization/AbstractStreamer.h:59}

---

variable
Util::Serialization::AbstractStreamer::CAP_SAVE_GENERIC

public

static

const uint8_t CAP_SAVE_GENERIC

Streamer supports the functionsaveGeneric.

_{Defined in Util/Serialization/AbstractStreamer.h:60}

---

function
Util::Serialization::AbstractStreamer::~AbstractStreamer

public

inline

virtual

~AbstractStreamer(	)

_{Defined in Util/Serialization/AbstractStreamer.h:33}

---

function
Util::Serialization::AbstractStreamer::loadGeneric

public

inline

virtual

GenericAttributeList * loadGeneric(	std::istream &	void )

Load generic data from the given stream.

Parameters

input

Use the data from the stream beginning at the preset position.

Returns

Description list containing the generic data. The caller is responsible for the memory deallocation.

_{Defined in Util/Serialization/AbstractStreamer.h:42}

---

function
Util::Serialization::AbstractStreamer::saveGeneric

public

inline

virtual

bool saveGeneric(	GenericAttributeList *	void,
	std::ostream &	void
)

Save generic data to the given stream.

Parameters

data

Description list containing the generic data to save.

output

Use the stream for writing beginning at the preset position.

Returns

trueif successful,falseotherwise

_{Defined in Util/Serialization/AbstractStreamer.h:54}

---

function
Util::Serialization::AbstractStreamer::queryCapabilities

public

static

inline

uint8_t queryCapabilities(	const std::string &	void )

Check which capabilities are supported for the given file extension.

Parameters

extension

File extension in lower case to check capabilities for.

Returns

Bitmask consisting of a combination ofCAP_LOAD_GENERIC,CAP_SAVE_GENERIC, flags that are defined by subclasses, or zero.

_{Defined in Util/Serialization/AbstractStreamer.h:68}

---

function
Util::Serialization::AbstractStreamer::AbstractStreamer

protected

inline

AbstractStreamer(	)

Creation is only possible in subclasses.

_{Defined in Util/Serialization/AbstractStreamer.h:74}

---