Comment.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 UML_COMMENT_HPP
#define UML_COMMENT_HPP

#include <UML/ModelElement.hpp>

namespace UML
{
  // forward declarations
  class Comment;
  class CommentImpl;
  class ModelElement;

  class Comment : virtual public UML::ModelElement
  {
  public:
    typedef OMF::BasicClass<CommentImpl> Proxy;

    Comment();
    virtual ~Comment();

    const OMF::String &body() const;
    void setBody(const OMF::String &value);
    void clearBody();

    const OMF::Set &annotatedElement();
    void addAnnotatedElement(ModelElement *value);
    void removeAnnotatedElement(ModelElement *value);
    void clearAnnotatedElement();

  private:
    OMF::String _body;
    OMF::Set _annotatedElement;
  };


  struct CommentImpl : virtual public UML::Comment
  {
    CommentImpl() : 
      OMF::ModelObject(
          "UML.Comment",
          &Comment::Proxy::instance(),
          &UMLPackage::instance()),
      Element(),
      ModelElement(),
      Comment()
    {}

    virtual ~CommentImpl()
    {}
  };
}

#endif

---