CConfigurationFile.h

Go to the documentation of this file.

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

// Copyright (C) 2008 - 2009 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., EML Research, gGmbH, University of Heidelberg,
// and The University of Manchester.
// All rights reserved.

// Copyright (C) 2006 - 2007 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc. and EML Research, gGmbH.
// All rights reserved.

#ifndef COPASI_CConfigurationFile
#define COPASI_CConfigurationFile

#include "utilities/CCopasiParameterGroup.h"
#include "MIRIAM/CMIRIAMResource.h"
#include "xml/CCopasiXMLInterface.h"

class CMIRIAMResources;

class CRecentFiles : public CCopasiParameterGroup
{
  // Operations
public:
  /**
   * Default constructor
   * @param const std::string & name (default: Recent Files)
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CRecentFiles(const std::string & name = "Recent Files",
               const CCopasiContainer * pParent = NULL);

  /**
   * Copy constructor
   * @param const CRecentFiles & src
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CRecentFiles(const CRecentFiles & src,
               const CCopasiContainer * pParent = NULL);

  /**
   * Specific constructor
   * @param const CCopasiParameterGroup & group
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CRecentFiles(const CCopasiParameterGroup & group,
               const CCopasiContainer * pParent = NULL);

  /**
   * Destructor
   */
  virtual ~CRecentFiles();

  /**
   * Add a file to the list of recent files
   * @param const std::string & file
   */
  void addFile(const std::string & file);

private:
  /**
   * Allocates all group parameters and assures that they are
   * properly initialized.
   */
  void initializeParameter();

  // Attributes
private:
  /**
   * A pinter to the maximal number of recent files
   */
  unsigned C_INT32 * mpMaxFiles;

  /**
   * A pointer to the list of recent files.
   */
  CCopasiParameterGroup * mpRecentFiles;
};

class CConfigurationFile : public CCopasiParameterGroup
{
  // Operations
public:
  /**
   * Default constructor
   * @param const std::string & name (default: Configuration)
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CConfigurationFile(const std::string & name = "Configuration",
                     const CCopasiContainer * pParent = NULL);

  /**
   * Copy constructor
   * @param const CConfigurationFile & src
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CConfigurationFile(const CConfigurationFile & src,
                     const CCopasiContainer * pParent = NULL);

  /**
   * Specific constructor
   * @param const CCopasiParameterGroup & group
   * @param const CCopasiContainer * pParent (default: NULL)
   */
  CConfigurationFile(const CCopasiParameterGroup & group,
                     const CCopasiContainer * pParent = NULL);

  /**
   * Destructor
   */
  virtual ~CConfigurationFile();

  /**
   * This methods must be called to elevate subgroups to
   * derived objects. The default implementation does nothing.
   * @return bool success
   */
  virtual bool elevateChildren();

  /**
   * Save the configuration file.
   * @return bool success
   */
  virtual bool save();

  /**
   * Load the configuration file.
   * @return bool success
   */
  virtual bool load();

  /**
   * Retrieve the list of recent files
   * @return CRecentFiles & recentFiles
   */
  CRecentFiles & getRecentFiles();

  /**
   * Retrieve the list of recent SBML files
   * @return CRecentFiles & recentSBMLFiles
   */
  CRecentFiles & getRecentSBMLFiles();

  //TODO SEDML
  /**
   * Retrieve the list of recent SEDML files
   * @return CRecentFiles & recentSEDMLFiles
   */
  CRecentFiles & getRecentSEDMLFiles();

  /**
   * Retrieve the list of recent MIRIAM Resources
   * @return CMIRIAMResources & recentMIRIAMResources
   */
  CMIRIAMResources & getRecentMIRIAMResources();

  void setRecentMIRIAMResources(const CMIRIAMResources & miriamResources);

  /**
   * Retrieve the application font.
   * @return const std::string & applicationFont
   */
  const std::string getApplicationFont() const;

  /**
   * Set the applications font.
   * @param const std::string & applicationFont
   */
  void setApplicationFont(const std::string & applicationFont);

  /**
   * Always perform unit validation
   * @return a flag indicating whether unit validation should always be performed
   */
  bool validateUnits() const;

  /**
   * Set whether unit validation should always be performed or not.
   * @param bool validateUnits
   */
  void setValidateUnits(bool validateUnits);

  /**
   * @return a flag on whether to use the open GL based rendering, or the Qt based one
   */
  bool useOpenGL() const;

  /**
   *  Set whether the openGL based rendering is to be used (true), or the Qt based one.
   */
  void setUseOpenGL(bool useOpenGL);

  /**
   * @return a flag on whether the sliders should react to keyboard input / mouse
   * interaction.
   */
  bool useAdvancedSliders() const;

  /**
   *  Set whether the sliders should react to keyboard input / mouse
   * interaction.
   */
  void setUseAdvancedSliders(bool useAdvancedSliders);

  /**
   * @return a flag on whether to use the advanced expression editing (i.e manually entering copasiobjects)
   */
  bool useAdvancedEditing() const;

  /**
   *  Set whether the  advanced expression editing (i.e manually entering copasiobjects) is to be used (true), or not
   */
  void setUseAdvancedEditing(bool useAdvancedEditing);

  /**
   * @return a flag on whether weights in Parameter Estimation should be normalized per experiment
   */
  bool normalizePerExperiment() const;

  /**
   *  Set whether weights in Parameter Estimation should be normalized per experiment
   */
  void setNormalizePerExperiment(bool flag);

  /**
   * Retrieve the web working directory
   * @return const std::string & workingDirectory
   */
  const std::string getWorkingDirectory() const;

  /**
   * Set the working directory.
   * @param const std::string & workingDirectory
   */
  void setWorkingDirectory(const std::string & workingDirectory);

private:
  /**
   * Allocates all group parameters and assures that they are
   * properly initialized.
   */
  void initializeParameter();

  // Attributes
private:
  /**
   * Class dealing with the loading and writing of the XML configuration
   * file.
   */
  class CXML : public CCopasiXMLInterface
  {
    // Operations
  public:
    /**
     * Constructor
     */
    CXML();

    /**
     * Destructor
     */
    ~CXML();

    /**
     * Save information to a given ostream.
     * @param std::ostream & os
     * @param const std::string & relativeTo
     * @return bool success
     */
    virtual bool save(std::ostream & os,
                      const std::string & relativeTo);

    /**
     * Load information from a given istream.
     * @param std::istream & is
     * @param const std::string & relativeTo
     * @return bool success
     */
    virtual bool load(std::istream & is,
                      const std::string & relativeTo);

    /**
     * Set the configuration contents
     * @param const CConfigurationFile & configuration
     */
    void setConfiguration(const CCopasiParameterGroup & configuration);

    /**
     * Retrieve the configuration contents
     * @return const CConfigurationFile & configuration
     */
    const CCopasiParameterGroup & getConfiguration() const;

    // Attributes
  private:
    /**
     * A pointer to the CCopasiParameterGroup containing the information
     */
    CCopasiParameterGroup mConfiguration;
  };

  /**
   * A pointer to the list of recent files
   */
  CRecentFiles * mpRecentFiles;

  /**
   * A pointer to the list of recent files
   */
  CRecentFiles * mpRecentSBMLFiles;

  //TODO SEDML
  /**
   * A pointer to the list of recent files
   */
  CRecentFiles * mpRecentSEDMLFiles;

  /**
   * A pointer to the list of MIRIAM Resources
   */
  CMIRIAMResources * mpRecentMIRIAMResources;

  /**
   * A pointer to the application font
   */
  std::string * mpApplicationFont;

  /**
   * A pointer indicating whether units will always be validated
   */
  bool * mpValidateUnits;

  /**
  * A pointer indicating whether to use the OpenGL rendering, or the Qt based one
   */
  bool *mpUseOpenGL;

  /**
  * A pointer indicating whether the sliders should react to keyboard input / mouse
   * interaction.
   */
  bool *mpUseAdvancedSliders;

  /**
   * A pointer indicating whether to use the advanced editing
   */
  bool *mpUseAdvancedEditing;

  /**
   * A pointer indicating whether to experiments should be normalized by default
   */
  bool *mpNormalizePerExperiment;

  /**
   * A pointer to the last used working directory of the GUI.
   */
  std::string * mpWorkingDirectory;
};

#endif // COPASI_CConfigurationFile