project.h

/*
 *  Copyright (c) 2005    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED_SCOPIRA_CORE_MODELGROUP_H__
#define __INCLUDED_SCOPIRA_CORE_MODELGROUP_H__

#include <map>

#include <scopira/core/model.h>
#include <scopira/tool/export.h>

namespace scopira
{
  namespace core
  {
    class project_i;
    class project_base;
  }
}

class scopira::core::project_i : public virtual scopira::core::model_i
{
  public:
    typedef scopira::core::model_iterator model_iterator;

  public:
    virtual bool is_project(void) const { return true; }

    SCOPIRA_EXPORT virtual void add_model(model_i *parent, model_i *rec) = 0;
    SCOPIRA_EXPORT virtual void remove_model(model_i *parent, model_i *rec) = 0;
    SCOPIRA_EXPORT virtual bool contains_model(model_i *parent, model_i *rec) = 0;
    SCOPIRA_EXPORT virtual bool contains_model(model_i *rec) = 0;

    SCOPIRA_EXPORT virtual model_i * get_parent(model_i *child) = 0;

    // future functions
    // something about properties
    // named-models? (or is that what find_model is for?)
    // rename get_parent to get_parent_model

    SCOPIRA_EXPORT virtual model_i * find_model(model_i *parent, const std::string &title) const = 0;

    SCOPIRA_EXPORT virtual model_iterator get_model_iterator(model_i *parent) const = 0;

    SCOPIRA_EXPORT virtual bool is_project_empty(void) const = 0;

    SCOPIRA_EXPORT virtual void clear_project(void) = 0;

    SCOPIRA_EXPORT virtual void move_project(scopira::core::project_i *rhs) = 0;

    SCOPIRA_EXPORT virtual bool get_tagged_model_from_project(model_i *parent, const std::string &name,
      scopira::tool::count_ptr<scopira::core::model_i> &out) = 0;

  protected:
    SCOPIRA_EXPORT project_i(void);
    SCOPIRA_EXPORT project_i(const std::string &title);
};

class scopira::core::project_base : public virtual scopira::core::project_i
{
  protected:
    // this is a MULTI map of parents->children
    typedef std::multimap< tool::count_ptr<core::model_i>, tool::count_ptr<core::model_i> > model_set_t;
    typedef std::pair<model_set_t::const_iterator, model_set_t::const_iterator> const_iterator_pair;
    typedef std::pair<model_set_t::iterator, model_set_t::iterator> iterator_pair;

    // this is a map of children, parent (reverse of the above)
    typedef std::map<core::model_i*, core::model_i*> child_map;

    // in the future, there will be a child->optional properties set
    // map here

    model_set_t dm_models;
    child_map dm_child;

  public:
    SCOPIRA_EXPORT project_base(void);
    SCOPIRA_EXPORT project_base(const std::string &title);

    SCOPIRA_EXPORT virtual ~project_base();

    SCOPIRA_EXPORT virtual bool load(tool::iobjflow_i& in);
    SCOPIRA_EXPORT virtual void save(tool::oobjflow_i& out) const;

    SCOPIRA_EXPORT virtual void add_model(model_i *parent, model_i *rec);
    SCOPIRA_EXPORT virtual void remove_model(model_i *parent, model_i *rec);
    SCOPIRA_EXPORT virtual bool contains_model(model_i *parent, model_i *rec);
    SCOPIRA_EXPORT virtual bool contains_model(model_i *rec);

    SCOPIRA_EXPORT virtual model_i * get_parent(model_i *child);

    SCOPIRA_EXPORT virtual model_i * find_model(model_i *parent, const std::string &title) const;

    SCOPIRA_EXPORT virtual model_iterator get_model_iterator(model_i *parent) const;

    SCOPIRA_EXPORT virtual bool is_project_empty(void) const;
    SCOPIRA_EXPORT virtual void clear_project(void);
    SCOPIRA_EXPORT virtual void move_project(scopira::core::project_i *rhs);

    SCOPIRA_EXPORT virtual bool get_tagged_model_from_project(model_i *parent, const std::string &name,
      scopira::tool::count_ptr<scopira::core::model_i> &out);

  private:
    void remove_by_range(model_set_t::iterator _begin, model_set_t::iterator _last);

    class project_iterator;
};

#endif