GemaCoreLib
The GeMA Core library
Public Member Functions | List of all members
GmStateDumpMatrixDataItem Class Reference

Class responsible for storing a GmMatrix object. More...

#include <gmStateDumpItem.h>

Inheritance diagram for GmStateDumpMatrixDataItem:
Inheritance graph
[legend]
Collaboration diagram for GmStateDumpMatrixDataItem:
Collaboration graph
[legend]

Public Member Functions

 GmStateDumpMatrixDataItem (int id, GmMatrix *mat, const GmLogCategory &logger, bool fixed, QString itemNamePrefix="")
 Constructor.
 
virtual int itemType () const
 Returns the item type.
 
- Public Member Functions inherited from GmStateDumpArmaDataItem< GmMatrix >
 GmStateDumpArmaDataItem (int id, GmMatrix *data, const GmLogCategory &logger, bool fixed, QString itemNamePrefix)
 
virtual int itemSize () const
 The item size needed for calculating sizes and offsets in bytes for partial updates. Includes the dimension.
 
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 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...
 
- Public Member Functions inherited from GmStateDumpBaseDataItem
 GmStateDumpBaseDataItem (int id, QString prefix, const GmLogCategory &logger)
 Constructor.
 
int id ()
 Returns the internal dump item id.
 
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.
 
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 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...
 

Additional Inherited Members

- 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.
 
- 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

Class responsible for storing a GmMatrix object.


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