CConfigurableObject.h

/*
    This software is Copyright by the Board of Trustees of Michigan
    State University (c) Copyright 2005.

    You may use this software under the terms of the GNU public license
    (GPL).  The terms of this license are described at:

     http://www.gnu.org/licenses/gpl.txt

     Author:
             Ron Fox
         NSCL
         Michigan State University
         East Lansing, MI 48824-1321
*/

#ifndef CCONFIGURABLEOBJECT_H
#define CCONFIGURABLEOBJECT_H

#include <string>

#ifndef CITEMCONFIGURATION_H
#include "CItemConfiguration.h"
#endif

class CConfigurableObject
{
  // Data:
protected:
  CItemConfiguration* m_pConfiguration;
private:
  bool                m_deleteOnDestroy;

  // Construction and canonicals:

public:
  CConfigurableObject();
  CConfigurableObject(const CConfigurableObject& rhs);
  virtual ~CConfigurableObject();

  CConfigurableObject& operator=(const CConfigurableObject& rsh);
  int operator==(const CConfigurableObject& rhs) const;
  int operator!=(const CConfigurableObject& rhs) const;

  // Attachment:

  void Attach(CItemConfiguration* pConfiguration, bool dynamic = true);

  // Configuration
  
  void configure(std::string name, std::string value);

  // Inquiry:

  std::string getName() const;
  std::string cget(std::string name);
  CItemConfiguration::ConfigurationArray cget();


  // Concrete classes must implement this interface:

  virtual void onAttach() = 0;  // Define the configuration parameters, normally.

  // Utilities
private:
  void throwIfNull(const char* message) const;

};

#endif