COPASI API  4.16.103
CLNAProblem.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/lna/CLNAProblem.h,v $
3 // $Revision: 1.1 $
4 // $Name: $
5 // $Author: jpahle $
6 // $Date: 2011/05/24 17:33:44 $
7 // End CVS Header
8 
9 // Copyright (C) 2011 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc., University of Heidelberg, and The University
11 // of Manchester.
12 // All rights reserved.
13 
14 /**
15  * CLNAProblem class.
16  * This class describes the LNA analysis problem.
17  *
18  * Created for Copasi by Juergen Pahle 2010
19  */
20 
21 #ifndef COPASI_CLNAProblem_H__
22 #define COPASI_CLNAProblem_H__
23 
24 #include <string>
25 
26 #include "model/CState.h"
28 #include "utilities/CReadConfig.h"
29 
30 class CSteadyStateTask;
31 
33 {
34  // Attributes
35 private:
36  /**
37  * The initial state, i.e., at which the LNA is calculated.
38  */
40 
41 public:
42  // Operations
43 
44  /**
45  * Default constructor.
46  * @param const CCopasiContainer * pParent (default: NULL)
47  */
48  CLNAProblem(const CCopasiContainer * pParent = NULL);
49 
50  /**
51  * Copy constructor.
52  * @param "const CLNAProblem &" src
53  * @paramconst CCopasiContainer * pParent (default: NULL)
54  */
55  CLNAProblem(const CLNAProblem & src,
56  const CCopasiContainer * pParent = NULL);
57 
58  /**
59  * Destructor.
60  */
61  virtual ~CLNAProblem();
62 
63  /**
64  * Set the model of the problem
65  * @param CModel * pModel
66  * @result bool succes
67  */
68  virtual bool setModel(CModel * pModel);
69 
70  /**
71  * Set the initial state of the problem.
72  * @param const CState & InitialState
73  */
74  void setInitialState(const CState & initialState);
75 
76  /**
77  * Retrieve the initial state of the problem.
78  * @return "const CState &" pInitialState
79  */
80  //const CState & getInitialState() const;
81 
82  /**
83  * Set whether the steady state analysis is requested.
84  * @param const bool & steadyStateRequested
85  */
86  void setSteadyStateRequested(const bool & steadyStateRequested);
87 
88  /**
89  * Retrieve whether a steady state analysis is requested.
90  * @return bool steadyStateRequested
91  */
92  bool isSteadyStateRequested() const;
93 
94  /**
95  * Retrieve the subtask
96  * return CSteadyStateTask * pSubTask;
97  */
98  CSteadyStateTask * getSubTask() const;
99 
100  /**
101  * Load a LNA problem
102  * @param "CReadConfig &" configBuffer
103  * @param "CReadConfig::Mode mode (Default: CReadConfig::NEXT)
104  */
105  void load(CReadConfig & configBuffer,
107 
108  /**
109  * This is the output method for any result of a problem. The default implementation
110  * is provided with CCopasiProblem. Does only print "Not implemented." To overide this
111  * default behaviour one needs to reimplement the virtual printResult function.
112  * @param std::ostream * ostream
113  */
114  virtual void printResult(std::ostream * ostream) const;
115 
116  /**
117  * Output stream operator. Prints description of the problem incl. the subtask
118  * @param ostream & os
119  * @param const CLNAProblem & A
120  * @return ostream & os
121  */
122  friend std::ostream &operator<<(std::ostream &os, const CLNAProblem & o);
123 
124  /**
125  * This is the output method for any object. It calls the insert operator<<
126  * @param std::ostream * ostream
127  */
128  virtual void print(std::ostream * ostream) const;
129 
130 private:
131 };
132 #endif /* COPASI_CLNAProblem_H__ */
virtual void print(std::ostream *ostream) const
virtual ~CLNAProblem()
Definition: CLNAProblem.cpp:50
void setInitialState(const CState &initialState)
Definition: CLNAProblem.cpp:85
virtual void printResult(std::ostream *ostream) const
Definition: CState.h:305
CLNAProblem(const CCopasiContainer *pParent=NULL)
Definition: CLNAProblem.cpp:30
friend std::ostream & operator<<(std::ostream &os, const CLNAProblem &o)
void setSteadyStateRequested(const bool &steadyStateRequested)
CState mInitialState
Definition: CLNAProblem.h:39
CSteadyStateTask * getSubTask() const
Definition: CModel.h:50
bool isSteadyStateRequested() const
void load(CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
Definition: CLNAProblem.cpp:67
virtual bool setModel(CModel *pModel)
Definition: CLNAProblem.cpp:57