GmStateDumpMapDataItem< K, V > Class Template Reference

Class responsible for storing a QMap of values. Usefull for storing generic sets of "scalar" attributes. More...

#include <gmStateDumpItem.h>

Inheritance diagram for GmStateDumpMapDataItem< K, V >:

Collaboration diagram for GmStateDumpMapDataItem< K, V >:

Public Member Functions
	GmStateDumpMapDataItem (int id, QMap< K, V > *data, bool fixedHint, const GmLogCategory &logger, QString itemNamePrefix="")
	Constructor.
virtual int	itemType () const
	Returns the item type.
virtual bool	canCompress () const
	Should this item be compressed if the MemoryDump object is configured with compression?
virtual bool	partialOp () const
	Does this item supports partial load / save operations?
virtual bool	fixedSize () const
	Is this dump item a fixed size item that probably won't grow in the future? If so, extra space will NOT be reserved on file for growing even if growing is configured on the memory dump object.
virtual bool	opStart (int op)
	Function called by GmMemoryDump::load(), GmMemoryDump::save(), GmMemoryDump::loadItem() and GmMemoryDump::saveItem() to indicate that a load (op == 1) or save (op == 0) operation on this item will begin. More...
virtual bool	opEnd (int op)
	Function called by GmMemoryDump::load(), GmMemoryDump::save(), GmMemoryDump::loadItem() and GmMemoryDump::saveItem() to indicate that a load (op == 1) or save (op == 0) operation was completed succesfully (it won't be called if the operation failed). More...
virtual qint64	size () const
	Returns the current item size (in bytes)
virtual bool	fillDataHeader (char *header)
	Function called together with getDataBuffer() to provide a "header information" with fixed size (equal to GM_MEMORY_DUMP_ITEM_DATA_SIZE) that is also saved for the dump item. This information is then made available when setDataBuffer() is called. More...
virtual void	getDataBuffer (GmMemoryBufferList &bufferList, qint64 size=0, qint64 offset=0)
	Fills the provided bufferList object with the set of buffers that together define the dump item data. More...
virtual bool	setDataBuffer (GmMemoryBufferList &bufferList, const char *header, qint64 size, qint64 offset=0)
	Fills the provided bufferList object with the set of buffers that should be used to update the dump item data. More...
virtual void	bufferReleased (int op, bool ok)
	Function called once after a call to getDataBuffer() / setDataBuffer() to inform the item data that the returned buffer will not be used anymore by the memory dump object. More...
Public Member Functions inherited from GmStateDumpBaseDataItem
	GmStateDumpBaseDataItem (int id, QString prefix, const GmLogCategory &logger)
	Constructor.
int	id ()
	Returns the internal dump item id.
virtual int	itemSize () const
	The item size needed for calculating sizes and offsets in bytes for partial updates. Includes the dimension.
virtual QString	itemName () const
	Returns the default item name composed of the object prefix + '_' + the object id, optionally followed by '_' + the name suffix (if nameSuffix returns a string different from "")
Public Member Functions inherited from GmMemoryDumpItem
virtual	~GmMemoryDumpItem ()
	Virtual destructor.

Protected Member Functions
virtual bool	fillMapData (QMap< K, V > *map)
	A virtual function called just before a save operation that can be used by derived classes to fill the map that will be saved. If it returns false, the save operation will be aborted.
virtual bool	mapDataLoaded (QMap< K, V > *map)
	A virtual function called just after a load operation that can be used by derived classes to validate the loaded data and fill its own structures. If it returns false, the load operation will be aborted.
Protected Member Functions inherited from GmStateDumpBaseDataItem
virtual QString	nameSuffix () const
	Virtual method returning the extra part of the item name, added to its standard prefix.

Private Attributes
QMap< K, V > *	_varMap
	The stored map.
bool	_fixedHint
	Does this object has a low probability of growing?
QByteArray	_data
	The serialized data.

Additional Inherited Members
Protected Attributes inherited from GmStateDumpBaseDataItem
int	_id
	The object id.
QString	_prefix
	The object name prefix.
const GmLogCategory &	_logger
	Basic logger object for dump messages.

Detailed Description

template<class K, class V>
class GmStateDumpMapDataItem< K, V >

Class responsible for storing a QMap of values. Usefull for storing generic sets of "scalar" attributes.

Member Function Documentation

bufferReleased()

template<class K , class V >

void GmStateDumpMapDataItem< K, V >::bufferReleased ( int  op, bool  ok  )

virtual

Function called once after a call to getDataBuffer() / setDataBuffer() to inform the item data that the returned buffer will not be used anymore by the memory dump object.

This function is always called after a buffer request, even on errors. On success, its call happends BEFORE the call to opEnd() (on errors, opEnd() is not called at all).

The ok parameter tells if the underlying buffer operation was well succeeded or not. If ok is false, the buffer contents for a setDataBuffer() operation is undefined. The op parameter is 0 if the finished operation was a get operation and 1 if it was a set operation.

Reimplemented from GmMemoryDumpItem.

fillDataHeader()

template<class K, class V>

virtual bool GmStateDumpMapDataItem< K, V >::fillDataHeader ( char *  header )

inlinevirtual

Function called together with getDataBuffer() to provide a "header information" with fixed size (equal to GM_MEMORY_DUMP_ITEM_DATA_SIZE) that is also saved for the dump item. This information is then made available when setDataBuffer() is called.

This function should fill the buffer with data and return true if it makes use of this functionality. Otherwise it can just return false indicating that the header was not updated at all.

It will be called even if size() returns zero.

Implements GmMemoryDumpItem.

getDataBuffer()

template<class K , class V >

void GmStateDumpMapDataItem< K, V >::getDataBuffer ( GmMemoryBufferList &  bufferList, qint64  size = 0, qint64  offset = 0  )

virtual

Fills the provided bufferList object with the set of buffers that together define the dump item data.

If size is NOT zero, the filled bufferList should present a partial view of that data with size bytes and starting at the given offset. Otherwise, the filled bufferList size should be equal to the size returned by size(). If partialOp() returns false, this function will always be called with size and offset equal to 0.

The pointers added to the bufferList MUST remain valid until a call to bufferReleased(). The function can assume that between a call to getDataBuffer() and its closing bufferReleased() there will be no other calls to getDataBuffer() or setDataBuffer().

If size() == 0, this function is allowed to return without adding any buffers to bufferList. Otherwise, it MUST fill it with at least one valid buffer.

Implements GmMemoryDumpItem.

opEnd()

template<class K , class V >

bool GmStateDumpMapDataItem< K, V >::opEnd ( int  op )

virtual

Function called by GmMemoryDump::load(), GmMemoryDump::save(), GmMemoryDump::loadItem() and GmMemoryDump::saveItem() to indicate that a load (op == 1) or save (op == 0) operation was completed succesfully (it won't be called if the operation failed).

If this function returns false, the operation will be aborted. This allows for the dump item to do some extra content validation after a load operation.

Reimplemented from GmMemoryDumpItem.

opStart()

template<class K , class V >

bool GmStateDumpMapDataItem< K, V >::opStart ( int  op )

virtual

Function called by GmMemoryDump::load(), GmMemoryDump::save(), GmMemoryDump::loadItem() and GmMemoryDump::saveItem() to indicate that a load (op == 1) or save (op == 0) operation on this item will begin.

If this function returns false, the operation will be aborted. It will be called before any calls to size(), fillDataHeader(), getDataBuffer(), setDataBuffer() or bufferReleased().

Reimplemented from GmMemoryDumpItem.

setDataBuffer()

template<class K , class V >

bool GmStateDumpMapDataItem< K, V >::setDataBuffer ( GmMemoryBufferList &  bufferList, const char *  header, qint64  size, qint64  offset = 0  )

virtual

Fills the provided bufferList object with the set of buffers that should be used to update the dump item data.

The header parameter provides the header information filled by fillDataHeader() when the item data was last saved. Its size is equal to GM_MEMORY_DUMP_ITEM_DATA_SIZE.

The size parameter informs the size of the data to be written. If the dump item can not cope with that size, the function should return false and leave the bufferList empty. The offset parameter is used for partial data updates to the area starting at the given offset. If partialOp() returns false, this function will always be called with offset equal to 0.

The pointers added to the bufferList MUST remain valid until a call to bufferReleased() , when its contents can then be used by the item data if needed. The function can assume that between a call to setDataBuffer() and its closing bufferReleased() there will be no other calls to setDataBuffer() or getDataBuffer().

This function will NOT be called with size == 0.

Implements GmMemoryDumpItem.

---

The documentation for this class was generated from the following files:

• inc/gmStateDumpItem.h
• src/gmStateDumpItem.cpp