examples/settingsManager/settingsManagerSim/testSettings.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

//\file testSettings.h
//\brief Test settings object which contains a double and a bool

#pragma once

//VR-Forces headers
#include "makSettingsManager/settingsObject.h"
#include "makSettingsManager/settingsObjectFactory.h"

//Boost headers
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/base_object.hpp>
#include <boost/serialization/export.hpp>
#include <boost/archive/xml_iarchive.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/archive/text_oarchive.hpp>

class DtTestSettings : public DtSettingsObject
{
public:
   //Default constructor, required for deserialization
   DtTestSettings();
   
   //Constructor
   DtTestSettings(std::string name);

  //Copy constructor
   DtTestSettings(const DtTestSettings& orig);

   //Equality operator
   virtual bool operator==(const DtSettingsObject & other) const;

   //Inequality operator
   virtual bool operator!=(const DtSettingsObject & other) const;

   //Used by DtSettingsManager::setSetting when it needs to update an
   //existing DtSettingsObject.
   virtual bool setFrom(const DtSettingsObject* other);
   
   //Clone operator, returns a new settings object which is a copy of this one.
   DtSettingsObject* clone() const;
  
   //Double Setting
   double doubleSetting() const;
   void setDoubleSetting(double setting);

   //Bool Setting
   bool boolSetting() const;
   void setBoolSetting(bool setting);

   //Creator
   static DtSettingsObject* create(DtSettingsObjectCreationParams& params);

private:
   //Serialization support; see the boost serialization documentation at
   //boost.org
   friend class boost::serialization::access;
   template<class Archive>
   void serialize(Archive & ar, const unsigned int version)
   {
      //Serialize the base class
      ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject);
      //Serialize the members
      ar & BOOST_SERIALIZATION_NVP(myDoubleSetting);
      ar & BOOST_SERIALIZATION_NVP(myBoolSetting);
   }

protected:
   double myDoubleSetting;
   bool myBoolSetting;
};