close Warning: Can't synchronize with repository "(default)" (/var/svn/tolp does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 2 and Version 3 of OfficialTolArchiveNetworkTolExcel


Ignore:
Timestamp:
Mar 25, 2011, 5:26:34 PM (15 years ago)
Author:
Víctor de Buen Remiro
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • OfficialTolArchiveNetworkTolExcel

    v2 v3  
    1515Activates the worksheet with specified name
    1616*/
    17 Real ActivateNamedWS(Text workSheetName, Real readRange, Real headerIndexedByName);
     17Real ActivateNamedWS(Text workSheetName, Real readRange, Real
     18headerIndexedByName);
    1819
    1920/*
    2021Non static method defined at TolExcel::@WorkBook
    2122Activates the n-th worksheet.
    22 If readRange is true then calls to GetSheetMaxRange with argument headerIndexedByName
     23If readRange is true then calls to GetSheetMaxRange with argument
     24headerIndexedByName
    2325*/
    2426Real ActivateWS(Real workSheetNumber, Real readRange, Real headerIndexedByName);
    … …  
    2628/*
    2729Non static method defined at TolExcel::@WorkBook
    28 Closes the workbook if it is has been open. If you doesn't close it, the workbook will be closed at instance destruction time.
     30Closes the workbook if it is has been open. If you doesn't close it, the
     31workbook will be closed at instance destruction time.
    2932*/
    3033Real Close(Real void);
    … …  
    3437Call to methodSet ReadMatrix(firstRow, col, _.maxRow-firstRow+1, 1)
    3538Method GetSheetMaxRange must be called before.
    36 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    37 Returns a Matrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     39You must set minRow and minCol members before to calling GetSheetMaxRange if
     40there are empty rows or columns before the data cells
     41Returns a Matrix with the numeric values of a rectangle of cells in the current
     42work sheet. Non numeric or empty cells will be interpreted as unknown values.
    3843*/
    3944Matrix GetFullColumn(Real col, Real firstRow);
    … …  
    4247Non static method defined at TolExcel::@WorkBook
    4348Call to methodSet ReadMatrix(firstRow, col, _.maxRow-firstRow+1, 1)
    44 where col is the index of the column which first row has the specified name.Method GetSheetMaxRange must be called before.
    45 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    46 Returns a Matrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     49where col is the index of the column which first row has the specified
     50name.Method GetSheetMaxRange must be called before.
     51You must set minRow and minCol members before to calling GetSheetMaxRange if
     52there are empty rows or columns before the data cells
     53Returns a Matrix with the numeric values of a rectangle of cells in the current
     54work sheet. Non numeric or empty cells will be interpreted as unknown values.
    4755*/
    4856Matrix GetFullColumnByName(Text name, Real firstRow);
    … …  
    5260Call to methodSet ReadMatrix(minRow=1, minCol=1, _.numRow, _.numCol)
    5361Method GetSheetMaxRange must be called before.
    54 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    55 Returns a Matrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     62You must set minRow and minCol members before to calling GetSheetMaxRange if
     63there are empty rows or columns before the data cells
     64Returns a Matrix with the numeric values of a rectangle of cells in the current
     65work sheet. Non numeric or empty cells will be interpreted as unknown values.
    5666*/
    5767Matrix GetFullMatrix(Real void);
    … …  
    5969/*
    6070Non static method defined at TolExcel::@WorkBook
    61 Call to methodSet GetRange(minRow=1, minCol=1, _.numRow, _.numCol, columnDefaults)
    62 Method GetSheetMaxRange must be called before.
    63 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    64 Returns a Set of Sets with the values of a rectangle of cells in the current work sheet. Each cell will have any of allowed types : Text, Real, Date.
    65 When argument columnDefaults is not the empty set, then if a cell hasn't the specified type for its column in argument columnDefaults, then the unknown value of the type will be returned.
     71Call to methodSet GetRange(minRow=1, minCol=1, _.numRow, _.numCol,
     72columnDefaults)
     73Method GetSheetMaxRange must be called before.
     74You must set minRow and minCol members before to calling GetSheetMaxRange if
     75there are empty rows or columns before the data cells
     76Returns a Set of Sets with the values of a rectangle of cells in the current
     77work sheet. Each cell will have any of allowed types : Text, Real, Date.
     78When argument columnDefaults is not the empty set, then if a cell hasn't the
     79specified type for its column in argument columnDefaults, then the unknown
     80value of the type will be returned.
    6681*/
    6782Set GetFullRange(Set columnDefaults);
    … …  
    7186Call to methodSet ReadSeries(minRow=1, minCol=1, _.numRow, _.numCol, dating)
    7287Method GetSheetMaxRange must be called before.
    73 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    74 Returns a Set of series with specified dating. The first columne in the range is considered as the dates supporting the data of the Series. Every column from the column 2 on is considered as the data of one Serie. If dating is W then it will readed from the cell at left top corner. If this cell is empty or it's not a valid TimeSet then the default dating C will be used.
     88You must set minRow and minCol members before to calling GetSheetMaxRange if
     89there are empty rows or columns before the data cells
     90Returns a Set of series with specified dating. The first columne in the range
     91is considered as the dates supporting the data of the Series. Every column from
     92the column 2 on is considered as the data of one Serie. If dating is W then it
     93will readed from the cell at left top corner. If this cell is empty or it's not
     94a valid TimeSet then the default dating C will be used.
    7595*/
    7696Set GetFullSeries(TimeSet dating, Text dateFormat);
    … …  
    80100Call to methodSet ReadVMatrix(firstRow, col, _.maxRow-firstRow+1, 1)
    81101Method GetSheetMaxRange must be called before.
    82 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    83 Returns a VMatrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     102You must set minRow and minCol members before to calling GetSheetMaxRange if
     103there are empty rows or columns before the data cells
     104Returns a VMatrix with the numeric values of a rectangle of cells in the
     105current work sheet. Non numeric or empty cells will be interpreted as unknown
     106values.
    84107*/
    85108VMatrix GetFullVColumn(Real col, Real firstRow);
    … …  
    88111Non static method defined at TolExcel::@WorkBook
    89112Call to methodSet ReadVMatrix(firstRow, col, _.maxRow-firstRow+1, 1)
    90 where col is the index of the column which first row has the specified name.Method GetSheetMaxRange must be called before.
    91 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    92 Returns a VMatrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     113where col is the index of the column which first row has the specified
     114name.Method GetSheetMaxRange must be called before.
     115You must set minRow and minCol members before to calling GetSheetMaxRange if
     116there are empty rows or columns before the data cells
     117Returns a VMatrix with the numeric values of a rectangle of cells in the
     118current work sheet. Non numeric or empty cells will be interpreted as unknown
     119values.
    93120*/
    94121VMatrix GetFullVColumnByName(Text name, Real firstRow);
    … …  
    98125Call to methodSet ReadVMatrix(minRow=1, minCol=1, _.numRow, _.numCol)
    99126Method GetSheetMaxRange must be called before.
    100 You must set minRow and minCol members before to calling GetSheetMaxRange if there are empty rows or columns before the data cells
    101 Returns a VMatrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     127You must set minRow and minCol members before to calling GetSheetMaxRange if
     128there are empty rows or columns before the data cells
     129Returns a VMatrix with the numeric values of a rectangle of cells in the
     130current work sheet. Non numeric or empty cells will be interpreted as unknown
     131values.
    102132*/
    103133Matrix GetFullVMatrix(Real void);
    … …  
    105135/*
    106136Non static method defined at TolExcel::@WorkBook
    107 Scans the current work sheet in order to stablish a rectangle of interesting cells, starting from cell [minRow,minCol], wich default value is [1,1]. Reads along first column until an empty cell is found to stablish maxCol. Then, reads along first row until an empty cell is found to stablish maxRow.
    108 If argument headerIndexedByName is true stores the cells of first row in member _.headers and indexes it.
     137Scans the current work sheet in order to stablish a rectangle of interesting
     138cells, starting from cell [minRow,minCol], wich default value is [1,1]. Reads
     139along first column until an empty cell is found to stablish maxCol. Then, reads
     140along first row until an empty cell is found to stablish maxRow.
     141If argument headerIndexedByName is true stores the cells of first row in member
     142_.headers and indexes it.
    109143Note that cells in first row cannot be repeated and must be of type Text.
    110144*/
    … …  
    119153/*
    120154Non static method defined at TolExcel::@WorkBook
    121 Reads from current active work sheet the content of specified cell returning one of these types: Text, Date, Real
     155Reads from current active work sheet the content of specified cell returning
     156one of these types: Text, Date, Real
    122157*/
    123158Anything ReadCell(Real row, Real col);
    … …  
    125160/*
    126161Non static method defined at TolExcel::@WorkBook
    127 Reads from current active work sheet the content of specified cell returning a Date
     162Reads from current active work sheet the content of specified cell returning a
     163Date
    128164*/
    129165Date ReadDate(Real row, Real col);
    … …  
    131167/*
    132168Non static method defined at TolExcel::@WorkBook
    133 Returns a Matrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     169Returns a Matrix with the numeric values of a rectangle of cells in the current
     170work sheet. Non numeric or empty cells will be interpreted as unknown values.
    134171*/
    135172Matrix ReadMatrix(Real row_ini, Real col_ini, Real row_num, Real col_num);
    … …  
    137174/*
    138175Non static method defined at TolExcel::@WorkBook
    139 Returns a Set of Sets with the values of a rectangle of cells in the current work sheet. Each cell will have any of allowed types : Text, Real, Date.
    140 When argument columnDefaults is not the empty set, then if a cell hasn't the specified type for its column in argument columnDefaults, then the unknown value of the type will be returned.
    141 */
    142 Set ReadRange(Real row_ini_, Real col_ini_, Real row_num, Real col_num, Set columnDefaults);
    143 
    144 /*
    145 Non static method defined at TolExcel::@WorkBook
    146 Reads from current active work sheet the content of specified cell returning a Real
     176Returns a Set of Sets with the values of a rectangle of cells in the current
     177work sheet. Each cell will have any of allowed types : Text, Real, Date.
     178When argument columnDefaults is not the empty set, then if a cell hasn't the
     179specified type for its column in argument columnDefaults, then the unknown
     180value of the type will be returned.
     181*/
     182Set ReadRange(Real row_ini_, Real col_ini_, Real row_num, Real col_num, Set
     183columnDefaults);
     184
     185/*
     186Non static method defined at TolExcel::@WorkBook
     187Reads from current active work sheet the content of specified cell returning a
     188Real
    147189*/
    148190Real ReadReal(Real row, Real col);
    … …  
    150192/*
    151193Non static method defined at TolExcel::@WorkBook
    152 Returns a Set of series with specified dating. The first columne in the range is considered as the dates supporting the data of the Series. Every column from the column 2 on is considered as the data of one Serie. If dating is W then it will readed from the cell at left top corner. If this cell is empty or it's not a valid TimeSet then the default dating C will be used.
    153 */
    154 Set ReadSeries(Real row_ini, Real col_ini, Real row_num, Real col_num, TimeSet dating, Text dateFormat);
    155 
    156 /*
    157 Non static method defined at TolExcel::@WorkBook
    158 Reads from current active work sheet the content of specified cell returning a Text
     194Returns a Set of series with specified dating. The first columne in the range
     195is considered as the dates supporting the data of the Series. Every column from
     196the column 2 on is considered as the data of one Serie. If dating is W then it
     197will readed from the cell at left top corner. If this cell is empty or it's not
     198a valid TimeSet then the default dating C will be used.
     199*/
     200Set ReadSeries(Real row_ini, Real col_ini, Real row_num, Real col_num, TimeSet
     201dating, Text dateFormat);
     202
     203/*
     204Non static method defined at TolExcel::@WorkBook
     205Reads from current active work sheet the content of specified cell returning a
     206Text
    159207*/
    160208Text ReadText(Real row, Real col);
    … …  
    162210/*
    163211Non static method defined at TolExcel::@WorkBook
    164 Returns a VMatrix with the numeric values of a rectangle of cells in the current work sheet. Non numeric or empty cells will be interpreted as unknown values.
     212Returns a VMatrix with the numeric values of a rectangle of cells in the
     213current work sheet. Non numeric or empty cells will be interpreted as unknown
     214values.
    165215*/
    166216VMatrix ReadVMatrix(Real row_ini, Real col_ini, Real row_num, Real col_num);
    … …  
    180230/*
    181231Non static method defined at TolExcel::@WorkBook
    182 Writes into the specified cell of current active work sheet the specified value with on of these types: Text, Date, Real
     232Writes into the specified cell of current active work sheet the specified value
     233with on of these types: Text, Date, Real
    183234*/
    184235Anything WriteCell(Real row, Real col, Anything value);
    … …  
    186237/*
    187238Non static method defined at TolExcel::@WorkBook
    188 Writes a Matrix in the range of cells starting with the specified cell of current active work sheet.
     239Writes a Matrix in the range of cells starting with the specified cell of
     240current active work sheet.
    189241Returns the number of modified cells.
    190242*/
    … …  
    193245/*
    194246Non static method defined at TolExcel::@WorkBook
    195 Writes a range of cells starting with the specified cell of current active work sheet. Set cellValues must be a set of sets which elements are of one of these types: Text, Real, Date.
     247Writes a range of cells starting with the specified cell of current active work
     248sheet. Set cellValues must be a set of sets which elements are of one of these
     249types: Text, Real, Date.
    196250Returns the number of modified cells.
    197251*/
    … …  
    200254/*
    201255Non static method defined at TolExcel::@WorkBook
    202 Writes a range of cells starting with the specified cell of current active work sheet. Set series must be a set of series with the same dating.
     256Writes a range of cells starting with the specified cell of current active work
     257sheet. Set series must be a set of series with the same dating.
    203258Returns the number of modified cells.
    204259*/
    … …  
    207262/*
    208263Non static method defined at TolExcel::@WorkBook
    209 Writes a VMatrix in the range of cells starting with the specified cell of current active work sheet.
     264Writes a VMatrix in the range of cells starting with the specified cell of
     265current active work sheet.
    210266Returns the number of modified cells.
    211267*/
    … …  
    232288/*
    233289Non static member defined at TolExcel::@WorkBook
    234 Column headers. Used in method GetSheetMaxRange when argument headerIndexedByName is true.
     290Column headers. Used in method GetSheetMaxRange when argument
     291headerIndexedByName is true.
    235292*/
    236293Set _.header = Copy(Empty);
    … …  
    238295/*
    239296Non static member defined at TolExcel::@WorkBook
    240 If true, the first row was interpreted as column headers and will be stored in _.header. Used in method GetSheetMaxRange.
     297If true, the first row was interpreted as column headers and will be stored in
     298_.header. Used in method GetSheetMaxRange.
    241299*/
    242300Real _.headerIndexedByName = False;
    … …  
    268326/*
    269327Non static member defined at TolExcel::@WorkBook
    270 First column to be readed in method GetSheetMaxRange. Must be set by user if it's not the fiersdt one before to calling GetSheetMaxRange
     328First column to be readed in method GetSheetMaxRange. Must be set by user if
     329it's not the fiersdt one before to calling GetSheetMaxRange
    271330*/
    272331Real minCol = 1;
    … …  
    274333/*
    275334Non static member defined at TolExcel::@WorkBook
    276 First row to be readed in method GetSheetMaxRange. Must be set by user if it's not the fiersdt one before to calling GetSheetMaxRange
     335First row to be readed in method GetSheetMaxRange. Must be set by user if it's
     336not the fiersdt one before to calling GetSheetMaxRange
    277337*/
    278338Real minRow = 1;
    … …  
    298358/*
    299359Static member defined at TolExcel::@WorkBook
    300 Maximum number of columns that a work sheet can store. Used in method GetSheetMaxRange.
     360Maximum number of columns that a work sheet can store. Used in method
     361GetSheetMaxRange.
    301362*/
    302363Static Real maxAllowedCol = 256;
    … …  
    304365/*
    305366Static member defined at TolExcel::@WorkBook
    306 Maximum number of rows that a work sheet can store. Used in method GetSheetMaxRange.
     367Maximum number of rows that a work sheet can store. Used in method
     368GetSheetMaxRange.
    307369*/
    308370Static Real maxAllowedRow = 256^2;