Changeset 1069 for library

Show
Ignore:
Timestamp:
06/09/10 19:36:07 (14 years ago)
Author:
mido
Message:

documentation of loggers updated

Location:
library/bdm
Files:
4 modified

Legend:

Unmodified
Added
Removed

  • library/bdm/base/loggers.cpp

    r1064 r1069  
    4848 
    4949void memlog::from_setting ( const Setting &set ) { 
     50    root::from_setting( set ); 
    5051    UI::get ( maxlen,  set, "maxlen", UI::compulsory ); 
    5152    UI::get ( filename, set, "filename" ); 

  • library/bdm/base/loggers.h

    r1064 r1069  
    2020using std::string; 
    2121 
    22 /*! 
    23  * Logging into matrices in data format in memory, optionally persisted into a file. 
     22/*! \brief Logging into matrices in data format in memory, optionally persisted into a file. 
    2423 */ 
    2524class memlog : public logger { 
    … …  
    8685 
    8786 
    88     /*! \brief UI for memlog 
     87   /*! Create object from the following structure 
    8988 
    9089    \code 
    91     logger = { 
    92         class = "memlog"; 
    93         filename = "file_name"; // resulting filename with vectors in it format and setting in cfg 
    94         maxlen = 100;           // size of memory buffer 
    95     } 
     90    class = 'memlog';     
     91    maxlen = [];               % size of memory buffer 
     92    --- optional fields --- 
     93    filename = 'file_name';    % resulting filename with vectors in itpp format and setting in cfg         
     94    --- inherited fields --- 
     95    bdm::logger::from_setting 
    9696    \endcode 
    9797     */ 
    … …  
    136136        cout << endl; 
    137137    } 
    138     /*! \brief UI for stdlog 
    139  
     138   /*! Create object from the following structure 
    140139    \code 
    141     logger = { 
    142         class = "stdlog"; // no parameterization needed 
    143     } 
     140    class = 'stdlog';   % no parameterization needed 
    144141    \endcode 
    145142    */ 
    … …  
    183180    void write_buffers ( int Len ); 
    184181 
    185     /*! \brief UI for dirfilelog (Kst file format) 
     182    /*! Create object from the following structure 
    186183    \code 
    187     logger = { 
    188         class = "dirfilelog"; 
    189         dirname = "directory_for_files"; // resulting files will be stored there 
    190         maxlen = 100;                    // size of memory buffer, when full results are written to disk 
    191     } 
     184    class = 'dirfilelog'; 
     185    dirname = 'directory_for_files'; % resulting files will be stored there 
     186    maxlen = [];                     % size of memory buffer, when full results are written to disk 
     187    --- inherited fields --- 
     188    bdm::memlog::from_setting 
    192189    \endcode 
    193190    */ 

  • library/bdm/mex/mex_logger.h

    r1064 r1069  
    4242} 
    4343 
    44 //! Logger storing results into an mxArray 
     44//! \brief Logger storing results into an mxArray 
    4545class mexlog : public memlog { 
    4646public: 
    … …  
    7474        return tmp; 
    7575    } 
    76     void from_setting ( const Setting &root ) { 
    77         maxlen = root["maxlen"]; 
     76 
     77    /*! Create object from the following structure 
     78 
     79    \code 
     80    class = 'mexlog';     
     81    maxlen = [];               % size of memory buffer 
     82    \endcode 
     83    */ 
     84    void from_setting ( const Setting &set ) { 
     85        UI::get ( maxlen,  set, "maxlen", UI::compulsory ); 
    7886    } 
     87 
    7988    Config& _setting_conf() { 
    8089        return setting_conf; 

  • library/bdm/stat/merger.h

    r1068 r1069  
    165165    eEmp& _Smp() { 
    166166        return eSmp; 
    167     } 
    168  
    169  
    170167    } 
    171168