SaveStatus.h

Go to the documentation of this file.

#ifndef SAVE_STATUS_H_
#define SAVE_STATUS_H_

#include "base/cleancontainers.h"
#include <string>


using namespace std;

/** @ingroup ftk
    @{


*/


/// This structure is used by the SaveStatus class.  It contains save status flags.
struct SaveFlag {
    bool _initSave;
    bool _saved;
    bool _notSaved;
    bool _requestRestore;
    bool _requestRestoreFailed;
    bool _restoreBegun;
    bool _initRestore;
    bool _restored;
    bool _notRestored;
};


typedef map<string, SaveFlag> SAVE_MAP;

typedef map<string, SaveFlag>::iterator SAVE_MAP_ITR;


/** The SaveStatus class handles the status flags that are set by the RTI Federate
    Ambassador during the Federation save and restore process. This class is used 
    by the TimeManager class.
*/
class SaveStatus
{
  public:
    /** This method initiates the Federation save process.
        @param saveLabel A string label that identifies the synchronization point.
        @return  The success if the registration call succeeded and false if a
  registration point with the samelable already exists.
    */
    bool initiateSave(string saveLabel);


    /** Get the flag that indicates save registration success.
  @param saveLabel A string label that identifies the synchronization point.
  @return the registered flag if it is set and false if the flag is not set.
    */
    bool initSaveFlagGet(string saveLabel);


    /** Get the flag that indicates the success of the save.
  @param saveLabel A string label that identifies the synchronization point.
  @return the saved flag if it is set and false if it is not set.
    */
    bool savedFlagGet(string saveLabel);


    /** Get the flag that indicates the save failed.
  @param saveLabel A string label that identifies the synchronization point.
  @return the notSaved flag if it is set and false if it is not set.
    */
    bool notSavedFlagGet(string saveLabel);


    /** Get the flag that indicates the restore succeeded.
  @param saveLabel A string label that identifies the synchronization point.
  @return the restoreSucceeded flag if it is set and false if it is not set.
    */
    bool requestRestoreFlagGet(string saveLabel);


    /** Get the flag that indicates the restore failed.
  @param saveLabel A string label that identifies the synchronization point.
  @return the restoreSucceeded flag if it is set and false if it is not set.
    */
    bool requestRestoreFailedFlagGet(string saveLabel);


    /** Get the flag that indicates synchronization restore begun.
  @param saveLabel A string label that identifies the synchronization point.
  @return the restoreBegun flag if it is set and false if it is not set.
    */
    bool restoreBegunFlagGet(string saveLabel);


    /** Get the flag that indicates synchronization restore initiated.
  @param saveLabel A string label that identifies the synchronization point.
  @return the initRestoreflag if it is set and false if it is not set.
    */
    bool initRestoreFlagGet(string saveLabel);


    /** Get the flag that indicates the synchronization has been restored.
  @param saveLabel A string label that identifies the synchronization point.
  @return the restored flag if it is set and false if it is not set.
    */
    bool restoredFlagGet(string saveLabel);


    /** Get the flag that indicates the synchronization has NOT been restored.
  @param saveLabel A string label that identifies the synchronization point.
  @return the notRestored flag if it is set and false if it is not set.
    */
    bool notRestoredFlagGet(string saveLabel);


    /** Set the initiate synchronization point save flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The initiateSave flag.
    */
    void initSaveFlagSet(string saveLabel, bool flag);


    /** Set the synchronization saved flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The saved flag.
    */
    void savedFlagSet(string saveLabel, bool flag);


    /** Set the synchronization not saved flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The notSaved flag.
    */
    void notSavedFlagSet(string saveLabel, bool flag);


    /** Set the requestRestore flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The requestRestore flag.
    */
    void requestRestoreFlagSet(string saveLabel, bool flag);


    /** Set the requestRestoreFailed flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The requestRestoreFailed flag.
    */
     void requestRestoreFailedFlagSet(string saveLabel, bool flag);


    /** Set the restoreBegun flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The restoreBegun flag.
    */
    void restoreBegunFlagSet(string saveLabel, bool flag);


    /** Set the initRestore flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The initRestore flag.
    */
    void initRestoreFlagSet(string saveLabel, bool flag);


    /** Set the restored flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The restored flag.
    */
    void restoredFlagSet(string saveLabel, bool flag);


    /** Set the notRestored flag.
  @param saveLabel A string label that identifies the synchronization point.
  @param flag The notRestored flag.
    */
    void notRestoredFlagSet(string saveLabel, bool flag);


    /** The reset method clears the saveFlag map.
     */
    void reset();

  private:
    SAVE_MAP _saveMap;

};

/** 
    @}
*/

#endif // SAVE_STATUS_H_

---