CLStyle.h

Go to the documentation of this file.

// Begin CVS Header
//   $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLStyle.h,v $
//   $Revision: 1.4 $
//   $Name:  $
//   $Author: shoops $
//   $Date: 2011/09/30 16:35:20 $
// End CVS Header

// Copyright (C) 2011 - 2010 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., University of Heidelberg, and The University
// of Manchester.
// All rights reserved.

#ifndef CLStyle_H__
#define CLStyle_H__

#include <set>
#include <string>

#include "copasi/layout/CLBase.h"
#include "copasi/layout/CLGroup.h"

#include "copasi/report/CCopasiContainer.h"

class Style;

class CLStyle : public CLBase, public CCopasiContainer
{
private:
  // prevent the compiler from generating the assignment operator
  CLStyle& operator=(const CLStyle& source);

protected:
  std::set<std::string> mRoleList;
  std::set<std::string> mTypeList;
  CLGroup* mpGroup;

  /**
   * key string for the style.
   */
  std::string mKey;

public:
  /**
   * Constructor.
   */
  CLStyle(const std::string& name, CCopasiContainer* pParent = NULL);

  /**
   * Copy Constructor.
   */
  CLStyle(const CLStyle& source, CCopasiContainer* pParent = NULL);

  /**
   * Constructor to generate object from the corresponding SBML object.
   */
  CLStyle(const Style& source, const std::string& name, CCopasiContainer* pParent = NULL);

  /**
   * Destructor
   */
  ~CLStyle();

  /**
   * Sets the group.
   */
  void setGroup(const CLGroup* pGroup);

  /**
   * Returns the group.
   */
  const CLGroup* getGroup() const;

  /**
   * Returns the group.
   */
  CLGroup* getGroup();

  /**
   * Returns the number of roles in the role list.
   */
  size_t getNumRoles() const;

  /**
   * Adds an role to the role list.
   */
  void addRole(const std::string& role);

  /**
   * Checks whether a given role is in the role list.
   */
  bool isInRoleList(const std::string& role) const;

  /**
   * Removes a role from the role list.
   */
  void removeRole(const std::string& role);

  /**
   * Sets the role list.
   */
  void setRoleList(const std::set<std::string>& roleList);

  /**
   * Returns the role list.
   */
  const std::set<std::string>& getRoleList() const;

  /**
   * Returns the type list.
   */
  const std::set<std::string>& getTypeList() const;

  /**
   * Sets the type list.
   */
  void setTypeList(const std::set<std::string>& typeList);

  /**
   * Returns the number of types in the type list.
   */
  size_t getNumTypes() const;

  /**
   * Adds a type to the type list.
   */
  void addType(const std::string& type);

  /**
   * Checks whether a given type is in the type list.
   */
  bool isInTypeList(const std::string& type) const;

  /**
   * Removes an type from the type list.
   */
  void removeType(const std::string& type);

  static void readIntoSet(const std::string& s, std::set<std::string>& set);

  static std::string createStringFromSet(const std::set<std::string>& set);

  /**
   * Returns the key of the style
   */
  const std::string& getKey() const;

  /**
   * Adds the attributes for a style object to the passed in.
   * object.
   */
  void addSBMLAttributes(Style* pStyle) const;
};

#endif /* CLStyle_H__ */