[Echempp-devel] Experiment/InputFilters/documentation Notes.log, 1.3, 1.4 mainpage.txt, 1.1, 1.2
Status: Beta
Brought to you by:
berndspeiser
|
From: beeblbrox <bee...@us...> - 2008-03-27 13:20:57
|
Update of /cvsroot/echempp/Experiment/InputFilters/documentation In directory sc8-pr-cvs17.sourceforge.net:/tmp/cvs-serv14930/Experiment/InputFilters/documentation Modified Files: Notes.log mainpage.txt Log Message: Updated docs for input filters. Index: mainpage.txt =================================================================== RCS file: /cvsroot/echempp/Experiment/InputFilters/documentation/mainpage.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** mainpage.txt 5 Jun 2006 10:05:12 -0000 1.1 --- mainpage.txt 27 Mar 2008 13:20:47 -0000 1.2 *************** *** 1,5 **** /*! \mainpage Documentation of InputFilters - InputFilter Object Library ! \author Bernd Speiser \section Introduction --- 1,5 ---- /*! \mainpage Documentation of InputFilters - InputFilter Object Library ! \author Bernd Speiser, Dominik Brugger \section Introduction *************** *** 11,13 **** --- 11,45 ---- electrochemistry. + InputFilters are intended for importing data written by other devices or programs + into ModSim. So far the imported data will be used for visualization only. + + The InputFilter framework is structured as follows: there is the abstract + base class InputFilter with two functions "is_valid_file" and "read" which + have to be implemented by all Filters. The "is_valid_file" function is used + to determine whether a given text file can be read by the corresponding filter, + where the actual reading is to be implemented in "read". + + To ease the use of different filters there is the class InputFilters which manages + all input filters for the user. Developers of new filters should "register" their + filters by changing InputFilters constructor. + + The input filter framework can be used as indicated by the following code snippet: + + <pre> + //// Create InputFilters object + experiment::InputFilters ipf; + //// Read from a text file, with the matching filter determined automatically + try + { + experiment::Experiment* ep = ipf->read("myfile.txt") + } + catch(std::exception& e) + { + //// InputFilters will throw an exception when no matching filter + //// is found or other errors occurr. + std::cerr << "Error: " << e.what() << std::endl; + } + </pre> + + */ Index: Notes.log =================================================================== RCS file: /cvsroot/echempp/Experiment/InputFilters/documentation/Notes.log,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Notes.log 7 Jun 2006 13:43:20 -0000 1.3 --- Notes.log 27 Mar 2008 13:20:47 -0000 1.4 *************** *** 1,2 **** --- 1,6 ---- + 27.03.2008 + New framework for InputFilters with example implementations for reading BAS + files with CV, CA, CC measurements and ASCII export files as written by ModSim. + 05.06.2006 |