Changes between Version 2 and Version 3 of HowToImplementNewFiller


Ignore:
Timestamp:
08/05/10 12:27:29 (14 years ago)
Author:
Takeshi Nakazato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • HowToImplementNewFiller

    v2 v3  
    5757To define new filler, you should go through the following steps:
    5858
    59  1. define your filler as a derived class of !FillerBase
     59=== 1. define your filler as a derived class of !FillerBase ===
    6060
    6161{{{
    … …  
    6767}}}
    6868
    69  2. define constructor
    70 
    71  Default constructor and copy constructor should be disabled from outside.
    72  So, they should be explicitly declared in the private section.
    73  The only public constructor is the one that takes Scantable object as its argument.
     69=== 2. define constructor ===
     70
     71Default constructor and copy constructor should be disabled from outside.
     72So, they should be explicitly declared in the private section.
     73The only public constructor is the one that takes Scantable object as its argument.
    7474
    7575{{{
    … …  
    8888}}}
    8989
    90  You probably need to have Reader object as an attribute.
     90You probably need to have Reader object as an attribute.
    9191
    9292{{{
    … …  
    107107}}}
    108108
    109  At least, the constructor must call the constructor of !FillerBase class.
     109At least, the constructor must call the constructor of !FillerBase class.
    110110
    111111{{{
    … …  
    118118}}}
    119119
    120  The constructor of !FillerBase class sets Scantable object given as a target.
    121 
    122  3. implement open() method
    123 
    124  You must implement open() method that gets an access to the data file.
    125  In almost case, it will be realized by the open() method of Reader object.
    126  You can call setHeader() to fill header of target Scantable.
     120The constructor of !FillerBase class sets Scantable object given as a target.
     121
     122=== 3. implement open() method ===
     123
     124You must implement open() method that gets an access to the data file.
     125In almost case, it will be realized by the open() method of Reader object.
     126You can call setHeader() to fill header of target Scantable.
    127127
    128128{{{
    … …  
    143143}}}
    144144
    145  The header variable must be set in the method.
    146 
    147  4. implement fill() method
    148 
    149  You must implement fill() method that performs 1) to fill row and 2) to add row to target Scantable.
    150  As mentioned above, a lot of useful methods are available.
     145The header variable must be set in the method.
     146
     147=== 4. implement fill() method ===
     148
     149You must implement fill() method that performs 1) to fill row and 2) to add row to target Scantable.
     150As mentioned above, a lot of useful methods are available.
    151151
    152152{{{
    … …  
    181181}}}
    182182
    183  5. implement close() method
    184 
    185  You must implement close() method. Normally, it just closes the file.
     183=== 5. implement close() method ===
     184
     185You must implement close() method. Normally, it just closes the file.
    186186
    187187{{{
    … …  
    196196}}}
    197197
    198  In this example, the method doesn't close the file explicitly.
    199  Instead, the file is closed when the Reader object is destructed.
     198In this example, the method doesn't close the file explicitly.
     199Instead, the file is closed when the Reader object is destructed.
    200200
    201201== Miscellaneous ==