COPASI API  4.16.103
CMoietiesTask.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/moieties/CMoietiesTask.h,v $
3 // $Revision: 1.4 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2011/03/07 19:31:28 $
7 // End CVS Header
8 
9 // Copyright (C) 2011 - 2010 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc., University of Heidelberg, and The University
11 // of Manchester.
12 // All rights reserved.
13 
14 // Copyright (C) 2008 by Pedro Mendes, Virginia Tech Intellectual
15 // Properties, Inc., EML Research, gGmbH, University of Heidelberg,
16 // and The University of Manchester.
17 // All rights reserved.
18 
19 #ifndef COPASI_CMoietiesTask
20 #define COPASI_CMoietiesTask
21 
23 
24 class CProcessReport;
25 
26 class CMoietiesTask : public CCopasiTask
27 {
28  //Attributes
29 
30 public:
31  /**
32  * The methods which can be selected for preforming this task.
33  */
34  static const unsigned int ValidMethods[];
35 
36  /**
37  * default constructor
38  * @param const CCopasiTask::Type & type (default: moieties)
39  * @param const CCopasiContainer * pParent (default: NULL)
40  */
42  const CCopasiContainer * pParent = NULL);
43 
44  /**
45  * Copy constructor
46  * @param const CMoietiesTask & src
47  */
48  //-CMoietiesTask(const CMoietiesTask & src);
49  CMoietiesTask(const CMoietiesTask & src, const CCopasiContainer * pParent = NULL);
50 
51  /**
52  * Destructor
53  */
55 
56  /**
57  * Set the call back of the task
58  * @param CProcessReport * pCallBack
59  * @result bool succes
60  */
61  virtual bool setCallBack(CProcessReport * pCallBack);
62 
63  /**
64  * Initialize the task. If an ostream is given this ostream is used
65  * instead of the target specified in the report. This allows nested
66  * tasks to share the same output device.
67  * @param const OutputFlag & of
68  * @param COutputHandler * pOutputHandler
69  * @param std::ostream * pOstream (default: NULL)
70  * @return bool success
71  */
72  virtual bool initialize(const OutputFlag & of,
73  COutputHandler * pOutputHandler,
74  std::ostream * pOstream);
75 
76  /**
77  * Process the task with or without initializing to the initial state.
78  * @param const bool & useInitialValues
79  * @return bool success
80  */
81  virtual bool process(const bool & useInitialValues);
82 
83  /**
84  * Perform necessary cleanup procedures
85  */
86  virtual bool restore();
87 
88  /**
89  * Set the method type applied to solve the task
90  * @param const CCopasiMethod::SubType & type
91  * @return bool success
92  */
93  virtual bool setMethodType(const int & type);
94 
95  /**
96  * Create a method of the specified type to solve the task.
97  * It is the duty of the caller to release the CCopasiMethod.
98  * @param const CCopasiMethod::SubType & type
99  * @return CCopasiMethod *
100  */
101  virtual CCopasiMethod * createMethod(const int & type) const;
102 };
103 #endif // COPASI_CMoietiesTask
virtual CCopasiMethod * createMethod(const int &type) const
virtual bool process(const bool &useInitialValues)
CMoietiesTask(const CCopasiTask::Type &type=CCopasiTask::moieties, const CCopasiContainer *pParent=NULL)
virtual bool setCallBack(CProcessReport *pCallBack)
virtual bool initialize(const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool setMethodType(const int &type)
virtual bool restore()
static const unsigned int ValidMethods[]
Definition: CMoietiesTask.h:34