importable_object.hpp

Go to the documentation of this file.

//
// See license.txt for license information.
//
// importable_object.hpp
//
// 17-Mar-2006  phamilton  Created
//

#ifndef incCOMMON_IMPORTABLE_OBJECT
#define incCOMMON_IMPORTABLE_OBJECT

// forwards
#include <string>
#include "object.hpp"

namespace ph {
namespace common {

// forwards

class importable_object_base
/**
        Abstract class representing the interface for an object that can be imported.
*/
{
public:
        virtual ~importable_object_base() {}
                
        virtual void setname(const std::string &name) = 0;
                //!< During importing, an object that can pretend to be another may have it's
                //! name set directly.
                
        virtual void addparam(const std::string &name, const std::string &value) = 0;
                //!< During importing, an object that can pretend to be another may have it's
                //! a parameter added to it. This is usually replaced in the text of
                //! values during the import.
};

}; // common
}; // ph

#endif // incCOMMON_IMPORTABLE_OBJECT

---