VAPOR3 3.9.4
Public Member Functions | List of all members
VAPoR::ParamsBase::StateSave Class Reference

State capture class. More...

#include <ParamsBase.h>

Public Member Functions

virtual void Reinit (const XmlNode *rootNode)
 
virtual void Save (const XmlNode *node, string description)
 
virtual void BeginGroup (string description)
 
virtual void EndGroup ()
 
virtual void IntermediateChange ()
 
virtual void SetEnabled (bool onOff)
 
virtual bool GetEnabled () const
 

Detailed Description

State capture class.

A class for capturing state changes. A pointer to an instance of this class is passed to the ParamsBase constructor. Any changes to the ParamsBase are recorded to StateSave by calling StateSave::Save() with the effected node and a description of the change. It is expected that users of ParamsBase will re-implement StateSave to suit their own needs

Definition at line 62 of file ParamsBase.h.

Member Function Documentation

◆ BeginGroup()

virtual void VAPoR::ParamsBase::StateSave::BeginGroup ( string  description)
inlinevirtual

Definition at line 71 of file ParamsBase.h.

◆ EndGroup()

virtual void VAPoR::ParamsBase::StateSave::EndGroup ( )
inlinevirtual

Definition at line 72 of file ParamsBase.h.

◆ GetEnabled()

virtual bool VAPoR::ParamsBase::StateSave::GetEnabled ( ) const
inlinevirtual

Definition at line 75 of file ParamsBase.h.

◆ IntermediateChange()

virtual void VAPoR::ParamsBase::StateSave::IntermediateChange ( )
inlinevirtual

Definition at line 73 of file ParamsBase.h.

◆ Reinit()

virtual void VAPoR::ParamsBase::StateSave::Reinit ( const XmlNode rootNode)
inlinevirtual

Capture current state

If the value of GetSaveState() is true this method is called prior to making any changes to the internal state

Definition at line 69 of file ParamsBase.h.

◆ Save()

virtual void VAPoR::ParamsBase::StateSave::Save ( const XmlNode node,
string  description 
)
inlinevirtual

Definition at line 70 of file ParamsBase.h.

◆ SetEnabled()

virtual void VAPoR::ParamsBase::StateSave::SetEnabled ( bool  onOff)
inlinevirtual

Definition at line 74 of file ParamsBase.h.


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