A basic interface used for creating dump items for objects that can be dumped by a composition of multiple individual dump items. More...

#include <gmStateDumpItem.h>

Inheritance diagram for GmGroupDumpItem:

[legend]

Public Member Functions
virtual	~GmGroupDumpItem ()
	Virtual destructor.

virtual bool	addStateItemsToGroup (GmStateDump *state, int groupId)=0
	Initialization method, called once, allowing the object to add its state items to the given group of the given sate dump object. The given group id is always a "concrete" group (never -1 or -2).

virtual bool	stateAboutToBeSaved (GmStateDump *state)
	Virtual method called just before starting a save operation on the given state. Returning false aborts the operation.

virtual bool	stateSaved (GmStateDump *state)
	Virtual method called just after succesfully completing a save operation on the given state. Returning false aborts the operation.

virtual bool	stateAboutToBeLoaded (GmStateDump *state)
	Virtual method called just before starting a load operation on the given state. Returning false aborts the operation.

virtual bool	stateLoaded (GmStateDump *state)
	Virtual method called just after succesfully completing a load operation on the given state. Returning false aborts the operation.

Detailed Description

A basic interface used for creating dump items for objects that can be dumped by a composition of multiple individual dump items.

This is useful for enabling plugin (process) returned handles to add items to a state dump and be notified of load and save dump operations. It is also used for saving boundary conditions to the state dump.

Member Function Documentation

◆ addStateItemsToGroup()

virtual bool GmGroupDumpItem::addStateItemsToGroup	(	GmStateDump *	state,
		int	groupId )

pure virtual

Initialization method, called once, allowing the object to add its state items to the given group of the given sate dump object. The given group id is always a "concrete" group (never -1 or -2).

Should return false on error, using the state logger to explain it.

Implemented in GmBoundaryConditionStateDumpItem, GmDiscontinuitySetStateDumpItem, GmFileIO, and GmMesh.