Log In | Get Help   
Home My Page Projects Code Snippets Project Openings Mareframe
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files
[mareframe] Annotation of /trunk/gadget/readword.h
[mareframe] / trunk / gadget / readword.h Repository:
ViewVC logotype

Annotation of /trunk/gadget/readword.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

1 : agomez 1 #ifndef readword_h
2 :     #define readword_h
3 :    
4 :     #include "commentstream.h"
5 :     #include "modelvariable.h"
6 :     #include "formula.h"
7 :    
8 :     /**
9 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number
10 :     * \param infile is the CommentStream to read from
11 :     * \param str is the char* that the text label will be compared to
12 :     * \param number is the integer that will store the value that has been read
13 :     */
14 :     void readWordAndVariable(CommentStream& infile, const char* str, int& number);
15 :     /**
16 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number
17 :     * \param infile is the CommentStream to read from
18 :     * \param str is the char* that the text label will be compared to
19 :     * \param number is the double that will store the value that has been read
20 :     */
21 :     void readWordAndVariable(CommentStream& infile, const char* str, double& number);
22 :     /**
23 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a Formula
24 :     * \param infile is the CommentStream to read from
25 :     * \param str is the char* that the text label will be compared to
26 :     * \param formula is the Formula that will store the value that has been read
27 :     */
28 :     void readWordAndVariable(CommentStream& infile, const char* str, Formula& formula);
29 :     /**
30 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a ModelVariable
31 :     * \param infile is the CommentStream to read from
32 :     * \param str is the char* that the text label will be compared to
33 :     * \param modelvariable is the ModelVariable that will store the value that has been read
34 :     * \param TimeInfo is the TimeClass for the current model
35 :     * \param keeper is the Keeper for the current model
36 :     */
37 :     void readWordAndModelVariable(CommentStream& infile, const char* str, ModelVariable& modelvariable,
38 :     const TimeClass* const TimeInfo, Keeper* const keeper);
39 :     /**
40 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a second string
41 :     * \param infile is the CommentStream to read from
42 :     * \param str is the char* that the text label will be compared to
43 :     * \param value is the char* that will store the value that has been read
44 :     */
45 :     void readWordAndValue(CommentStream& infile, const char* str, char* value);
46 :     /**
47 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number
48 :     * \param infile is the CommentStream to read from
49 :     * \param str is the char* that the text label will be compared to
50 :     * \param number1 is the integer that will store the first value that has been read
51 :     * \param number2 is the integer that will store the second value that has been read
52 :     */
53 :     void readWordAndTwoVariables(CommentStream& infile, const char* str, int& number1, int& number2);
54 :     /**
55 :     * \brief This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number
56 :     * \param infile is the CommentStream to read from
57 :     * \param str is the char* that the text label will be compared to
58 :     * \param number1 is the double that will store the first value that has been read
59 :     * \param number2 is the double that will store the second value that has been read
60 :     */
61 :     void readWordAndTwoVariables(CommentStream& infile, const char* str, double& number1, double& number2);
62 :    
63 :     #endif

root@forge.cesga.es
ViewVC Help
Powered by ViewVC 1.0.0  

Powered By FusionForge