ModelElement.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 MODEL_MODELELEMENT_HPP
#define MODEL_MODELELEMENT_HPP

// OMF includes
#include <OMF/ModelObject.hpp>

// Model includes
#include <Model/ModelPackage.hpp>

namespace Model
{
  // forward declarations
  class Namespace;
  class Constraint;

  class ModelElement : virtual public OMF::ModelObject
  {
  public:
    typedef OMF::BasicClass<ModelElement, OMF::Abstract> Proxy;
    
    ModelElement();
    virtual ~ModelElement();

    const OMF::String &name() const;
    void setName(const OMF::String &name);
    void clearName();

    const OMF::String &annotation() const;
    void setAnnotation(const OMF::String &annotation);
    void clearAnnotation();

    const OMF::Set &requiredElements() const;
    void addRequiredElements(ModelElement *element);
    void removeRequiredElements(ModelElement *element);
    void clearRequiredElements();

    const OMF::Set &constraints() const;
    void addConstraints(Constraint *constraint);
    void removeConstraints(Constraint *constraint);
    void clearConstraints();

    Namespace *container();
    void setContainer(Namespace *container);
    void clearContainer();

    const OMF::List &qualifiedName();

    OMF::Set findRequiredElements(const OMF::Set &kinds,
          const OMF::Boolean &recursive);

    OMF::Boolean isRequiredBecause(ModelElement *otherElement,
           OMF::String &reason);

    OMF::Boolean isFrozen();

    OMF::Boolean isVisible(ModelElement *otherElement);

  private:
    OMF::String   _name;
    OMF::String   _annotation;
    OMF::List   _qualifiedName;
    OMF::Set    _requiredElements;
    OMF::Set    _constraints;
    Namespace        *_container;
  };
}

#endif

---