ModelObject.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2004  Andrew Sutton
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to:
 *
 * The Free Software Foundation, Inc.
 * 59 Temple Place, Suite 330
 * Boston, MA  02111-1307  USA
 *
 * Contact:
 *   Andrew Sutton  asutton@cs.kent.edu
 */

#ifndef OMF_MODELOBJECT_HPP
#define OMF_MODELOBJECT_HPP

// std includes
#include <string>
#include <map>

// OMF includes
#include <OMF/Object.hpp>
#include <OMF/Types.hpp>
#include <OMF/Exception.hpp>
#include <OMF/Property.hpp>
#include <OMF/Method.hpp>
#include <OMF/Extension.hpp>
#include <OMF/Class.hpp>
#include <OMF/Package.hpp>

namespace OMF
{
  // forward declarations
  class Model;

  class ModelObject : public Object
  {
  protected:
    explicit ModelObject()
    {}

    ModelObject(const std::string &mc, Class *proxy, Package *decl);

  public:
    virtual ~ModelObject();

    virtual unsigned hashCode() const;

    virtual const std::string &typeCode() const;

    const std::string id() const
    { return _id; }

    void setId(const std::string &id)
    { _id = id; }

    void incRef();
    void decRef();

    void purge();

    ModelObject *parent()
    { return _parent; }

    void setParent(ModelObject *parent);

    Model *model()
    { return _model; }

    void setModel(Model *model);

    const std::vector<Property *> &propertyList() const
    { return _propList; }

    const std::map<std::string, Property *> &allProperties() const
    { return _propMap; }

    bool hasProperty(const std::string &name) const;

    Property *getProperty(const std::string &name) const;

    Object *get(const std::string &name);

    void set(const std::string &name, Object *value);

    void add(const std::string &name, Object *value);

    void remove(const std::string &name, Object *value);

    void clear(const std::string &name);


    void extend(Extension *ext);

    template <class Type>
    void extendWith(const std::string &name, Type &value)
    {
      extend(new BasicExtension<Type>(name, value));
    }

    template <class Type>
    void extendWith(const std::string &name)
    {
      extend(new BasicExtension<Type>(name));
    }

    bool hasExtension(const std::string &name);

    Extension *extension(const std::string &name);

    void removeExtension(const std::string &name);


    Class *proxy()
    { return _proxy; }

    Package *decl()
    { return _decl; }

  protected:
    Property &defProperty(const std::string &name);
    
  private:
    typedef std::vector<Property *> PropertyVector;
    typedef std::map<std::string, Property *> PropertyMap;
    typedef std::map<std::string, Method *> MethodMap;
    typedef std::map<std::string, Extension *> ExtensionMap;

    unsigned    _refCount;
    std::string   _id;
    PropertyVector  _propList;
    PropertyMap   _propMap;
    MethodMap   _methMap;
    ExtensionMap  _extMap;
    Model        *_model;
    Class        *_proxy;
    Package        *_decl;
    ModelObject        *_parent;
  };
}

#endif

---