include/makSettingsManager/settingsObject.h

Go to the documentation of this file.

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

// \file settingsObject.h
// \brief Base class for all settings objects used by DtSettings.

#ifndef settingsObject_H_
#define settingsObject_H_

// std includes
#include <string>

// Boost includes
#include <boost/serialization/nvp.hpp>
#include <boost/archive/xml_iarchive.hpp>
#include <boost/archive/xml_oarchive.hpp>


#include "makSettingsManager/makSettingsManagerDefines.h"
class DT_DLL_makSettingsManager DtSettingsObject
{
public:
   // Default constructor, required for deserialization   
   DtSettingsObject();
   
   // Constructor
   DtSettingsObject(std::string name);
   
   // Copy constructor
   DtSettingsObject(const DtSettingsObject& orig);
   
   // Assignment operator
   virtual void operator=(const DtSettingsObject& orig);

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

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

   // Clone operator, returns a new settings which is a copy of this one.
   virtual DtSettingsObject* clone() const = 0;
   
   // Accessor for the setting name
   virtual std::string name() const;

   // Reset this object based on another, used by DtSettingsManager::setSetting
   virtual bool setFrom(const DtSettingsObject* other);

private:
   friend class boost::serialization::access;
   // Serialization support. Derived classes must call 
   // BOOST_SERIALIZATION_BASE_OBJECT_NVP(DtSettingsObject) in their
   // implementation of serialize.
   template<class Archive>
   void serialize(Archive & ar, const unsigned int version)
   {
      ar & BOOST_SERIALIZATION_NVP(myName);
   }
   
protected:
   std::string myName;
};

// Setup this class as abstract in boost
BOOST_SERIALIZATION_ASSUME_ABSTRACT(DtSettingsObject)

#endif