Model.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_MODEL_HPP
#define OMF_MODEL_HPP

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

namespace OMF
{
  // forward declarations
  class Package;
  class ModelObject;

  class Model
  {
  public:
    enum Mode {
      ReadOnly,
      ReadWrite
    };

    Model();
    ~Model();

    const std::string &fileName() const
    { return _filename; }

    void setFileName(const std::string &fname)
    { _filename = fname; }

    const std::string &path() const
    { return _path; }

    void setPath(const std::string &path)
    { _path = path; }

    Mode mode() const
    { return _mode; }

    void setMode(Mode mode)
    { _mode = mode; }


    bool read(const char *filename);

    bool write(const char *filename);

    const std::list<ModelObject *> &elements() const
    { return _elements; }

    void addElement(ModelObject *elem);

    void removeElement(ModelObject *elem);

    void identifyElement(ModelObject *elem);

    ModelObject *findElement(const std::string &id);

    void enableIdentification(bool id)
    { _identify = id; }

    std::string generateId();

    void nextId()
    { _idAllocator++; }

    unsigned currentId() const
    { return _idAllocator; }


    const std::set<Package *> metamodels() const
    { return _metamodels; }

    void addMetamodel(Package *pkg)
    { _metamodels.insert(pkg); }

  private:
    typedef std::map<std::string, ModelObject *> IdMap;

    bool      _identify;
    unsigned      _idAllocator;
    std::string     _filename;
    std::string     _path;
    Mode      _mode;
    std::list<ModelObject *>  _elements;
    std::set<Package *>   _metamodels;
    IdMap     _idMap;

  };
}

#endif

---