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/readaggregation.h
[mareframe] / trunk / gadget / readaggregation.h Repository:
ViewVC logotype

Annotation of /trunk/gadget/readaggregation.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

1 : agomez 1 #ifndef readaggregation_h
2 :     #define readaggregation_h
3 :    
4 :     #include "commentstream.h"
5 :     #include "intmatrix.h"
6 :     #include "doublematrix.h"
7 :     #include "charptrmatrix.h"
8 :     #include "formulamatrix.h"
9 :    
10 :     /**
11 :     * \brief This is the function that will read aggregation data from a file into a matrix
12 :     * \param infile is the CommentStream to read the aggregation data from
13 :     * \param agg is the IntMatrix that the aggregated data will be stored in
14 :     * \param aggindex is the CharPtrVector that the aggregated data labels will be stored in
15 :     * \return number of aggregation entries read
16 :     */
17 :     int readAggregation(CommentStream& infile, IntMatrix& agg, CharPtrVector& aggindex);
18 :     /**
19 :     * \brief This is the function that will read aggregation data from a file into a vector
20 :     * \param infile is the CommentStream to read the aggregation data from
21 :     * \param agg is the IntVector that the aggregated data will be stored in
22 :     * \param aggindex is the CharPtrVector that the aggregated data labels will be stored in
23 :     * \return number of aggregation entries read
24 :     */
25 :     int readAggregation(CommentStream& infile, IntVector& agg, CharPtrVector& aggindex);
26 :     /**
27 :     * \brief This is the function that will read length aggregation data from a file
28 :     * \param infile is the CommentStream to read the aggregation data from
29 :     * \param lengths is the DoubleVector that the aggregated length data will be stored in
30 :     * \param lenindex is the CharPtrVector that the aggregated length labels will be stored in
31 :     * \return number of length aggregation entries read
32 :     */
33 :     int readLengthAggregation(CommentStream& infile, DoubleVector& lengths, CharPtrVector& lenindex);
34 :     /**
35 :     * \brief This is the function that will read prey aggregation data from a file
36 :     * \param infile is the CommentStream to read the aggregation data from
37 :     * \param preynames is the CharPtrVector that the prey names will be stored in
38 :     * \param preylengths is the DoubleMatrix that the aggregated prey length data will be stored in
39 :     * \param digestioncoeff is the FormulaMatrix that the prey digestion data will be stored in
40 :     * \param preyindex is the CharPtrVector that the aggregated prey labels will be stored in
41 :     * \param keeper is the Keeper for the current model
42 :     * \return number of prey aggregation entries read
43 :     */
44 :     int readPreyAggregation(CommentStream& infile, CharPtrMatrix& preynames, DoubleMatrix& preylengths,
45 :     FormulaMatrix& digestioncoeff, CharPtrVector& preyindex, Keeper* const keeper);
46 :    
47 :     #endif

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

Powered By FusionForge