SignStateManager Class Reference

#include <SignStateManager.h>

Collaboration diagram for SignStateManager:

[legend]List of all members.

---

Detailed Description

Stores and manages checkpoints.

This class is responsible for the management of application states/checkpoints. They can be saved, restored, and deleted.

Author:

Arne Hans

Public Member Functions
	SignStateManager (SignContext *newSignContext)
	~SignStateManager ()
	Destructor.
SignState *	SaveState (std::string name, vtkKWFrame *frame)
SignState *	RestoreState (std::string name)
void	DeleteState (std::string name)
bool	CheckState (std::string name)
SignState *	GetCurrentState ()

---

Constructor & Destructor Documentation

SignStateManager::SignStateManager (  SignContext *  newSignContext  )

Constructor Parameters: newSignContext  Pointer to the current SIGN context

SignStateManager::~SignStateManager (   )

Destructor.

---

Member Function Documentation

bool SignStateManager::CheckState (  std::string  name  )

Checks if a checkpoint exists Parameters: name  Name of the checkpoint Returns: True, if the checkpoint has been saved before, false otherwise.

void SignStateManager::DeleteState (  std::string  name  )

Deletes a checkpoint. Parameters: name  Name of the checkpoint If the checkpoint does not exist, a SignException is thrown.

SignState * SignStateManager::GetCurrentState (   )

Gets a pointer to the current state Returns: A SignState object with up-to-date XML documents, but no other stored settings.

SignState * SignStateManager::RestoreState (  std::string  name  )

Restores a previously saved checkpoint Parameters: name  Name of the checkpoint. If the checkpoint does not exist, a SignException is thrown. Returns: Pointer to the state that was restored

SignState * SignStateManager::SaveState (  std::string  name, vtkKWFrame *  frame )

Creates a new checkpoint and saves it Parameters: name  Name of the checkpoint frame  Pointer to a KWWidgets frame where the menu entry was created. This parameter is not used inside SignStateManager and can be NULL if the calling application does not rely on it. Returns: Pointer to the created SignState object

---

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

• core/SignStateManager.h
• core/SignStateManager.cxx

---