include/makSettingsManager/boolSetting.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: boolSetting.h,v $ $Revision: 1.6 $ $State: Exp $
*******************************************************************************/

// \file boolSetting.h
// \brief Generic boolean object for use with DtSettingsManager
// This is a general purpose boolean object which is instantiated by
// DtSettingsManager::addIndependentBool.

#ifndef boolSetting_H_
#define boolSetting_H_

#include "makSettingsManager/settingsObject.h"
#include "makSettingsManager/settingsObjectFactory.h"

#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>

#include "makSettingsManager/makSettingsManagerDefines.h"
class DT_DLL_makSettingsManager DtBoolSetting : public DtSettingsObject
{
public:
   // Default constructor, required for deserialization
   DtBoolSetting();
   
   // Constructor
   DtBoolSetting(std::string name, bool value);

   // Copy constructor
   DtBoolSetting(const DtBoolSetting& 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 which is a copy of this one.
   virtual DtSettingsObject* clone() const;

   // The boolean value
   bool value() const;
   void setValue(bool value);
      
private:
   // Serialization support
   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(myValue);
   }

protected:
   bool myValue;
};


#endif