CScanTask.h

Go to the documentation of this file.

// Copyright (C) 2010 - 2014 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) 2003 - 2007 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc. and EML Research, gGmbH.
// All rights reserved.

/**
 * CScanTask class.
 *
 * This class implements a scan task which is comprised of a
 * of a problem and a method.
 *
 */

#ifndef COPASI_CScanTask
#define COPASI_CScanTask

#include "utilities/CReadConfig.h"
#include "scan/CScanMethod.h"
#include "utilities/CVector.h"
#include "scan/CScanProblem.h"

class CScanMethod;
class CReport;

class CScanTask : public CCopasiTask
{
  //Attributes
private:

  /**
   * Pointer to the output stream for reporting
   */
  //std::ostream * mpOut;

  /**
   * for progress bar
   */
  unsigned C_INT32 mProgress;

  /**
   * Handle to process item
   */
  size_t mhProgress;

  /**
   * the subtask
   */
  CCopasiTask* mpSubtask;

  bool mOutputInSubtask;

  bool mUseInitialValues;

public:

  /**
   * default constructor
   */
  CScanTask(const CCopasiContainer * pParent = NULL);

  /**
   * Copy constructor
   * @param const CScanTask & src
   */
  //-CScanTask(const CScanTask & src);
  CScanTask(const CScanTask & src, const CCopasiContainer * pParent = NULL);

  /**
   * Destructor
   */
  ~CScanTask();

  /**
   * cleanup()
   */
  void cleanup();

  /**
   * Create a method of the specified type to solve the task.
   * It is the duty of the caller to release the CCopasiMethod.
   * @param const CCopasiMethod::SubType & type
   * @return CCopasiMethod *
   */
  virtual CCopasiMethod * createMethod(const int & type) const;

  /**
   * Initialize the task. If an ostream is given this ostream is used
   * instead of the target specified in the report. This allows nested
   * tasks to share the same output device.
   * @param const OutputFlag & of
   * @param COutputHandler * pOutputHandler
   * @param std::ostream * pOstream (default: NULL)
   * @return bool success
   */
  virtual bool initialize(const OutputFlag & of,
                          COutputHandler * pOutputHandler,
                          std::ostream * pOstream);

  /**
   * Process the task with or without initializing to the initial state.
   * @param const bool & useInitialValues
   * @return bool success
   */
  virtual bool process(const bool & useInitialValues);

  /**
   * Perform necessary cleanup procedures
   */
  virtual bool restore();

  /**
   * Loads parameters for this solver with data coming from a
   * CReadConfig object. (CReadConfig object reads an input stream)
   * @param configbuffer reference to a CReadConfig object.
   */
  void load(CReadConfig & configBuffer);

  /**
   * Do the subtask and the output
   */
  bool processCallback();

  /**
   * output separators
   * if isLast==true this method has to decide if a separator should
   * be generated dependent on mOutputInSubtask.
   */
  bool outputSeparatorCallback(bool isLast = false);

  /**
   * Fix files written with Version 4.12.81 and earlier, which wrote the exp(mean) and exp(std. deviation) for
   * normal random distributions in the scan task.
   */
  void fixBuild81();

protected:

  /**
   * Init the subtask
   * @param const OutputFlag & of
   * @param COutputHandler * pOutputHandler
   * @return success
   */
  bool initSubtask(const OutputFlag & of,
                   COutputHandler * pOutputHandler,
                   std::ostream * pOstream);
};
#endif // COPASI_CScanTask