Ignore:
Timestamp:
Nov 25, 2009 10:40:35 AM (11 years ago)
Author:
dkearney
Message:

updating python objects api with example code, fixes for tcl objects api

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/examples/objects/api/python/number

    r1610 r1619  
    4646    Notes: input arguments are used to construct the number object
    4747    Code Example:
     48    {{{
     49        n1 = Rappture.Number()
     50        n2 = Rappture.Number("temperature","K",300)
     51        n3 = Rappture.Number("temperature",units="K",300,min=0,max=500,
     52                                 label="Ambiant Temperature",
     53                                 desc="Temperature of the environment")
     54    }}}
    4855
    4956Rappture.Number(numObj)
     
    5461    Notes: None
    5562    Code Example:
     63    {{{
     64        n1 = Rappture.Number()
     65        n2 = Rappture.Number(n1)
     66    }}}
    5667
    5768
     
    6677           val, if provided, is used to set the object name
    6778    Code Example:
     79    {{{
     80        n = Rappture.Number()
     81        n.name()
     82        # ""
     83        n.name("temperature")
     84        n.name()
     85        # "temperature"
     86    }}}
    6887
    6988n.path([val])
     
    7796           val, if provided, is used to set the object path
    7897    Code Example:
     98    {{{
     99        n = Rappture.Number()
     100        n.path()
     101        # ""
     102        n.path("input")
     103        n.path()
     104        # "input"
     105    }}}
    79106
    80107n.label([val])
     
    87114           val, if provided, is used to set the object label
    88115    Code Example:
     116    {{{
     117        n = Rappture.Number()
     118        n.label()
     119        # ""
     120        n.label("Ambiant temperature")
     121        n.label()
     122        # "Ambiant temperature"
     123    }}}
    89124
    90125n.desc([val])
     
    99134           val, if provided, is used to set the object description
    100135    Code Example:
     136    {{{
     137        n = Rappture.Number()
     138        n.desc()
     139        # ""
     140        n.desc("Temperature of the environment")
     141        n.desc()
     142        # "Temperature of the environment"
     143    }}}
    101144
    102145n.hints([val])
     
    109152           val, if provided, is used to set the object hints
    110153    Code Example:
     154    {{{
     155        n = Rappture.Number()
     156        n.hints()
     157        # ""
     158        n.hints("none")
     159        n.hints()
     160        # "none"
     161    }}}
    111162
    112163n.color([val])
     
    119170           val, if provided, is used to set the object color
    120171    Code Example:
     172    {{{
     173        n = Rappture.Number()
     174        n.color()
     175        # ""
     176        n.color("none")
     177        n.color()
     178        # "none"
     179    }}}
    121180
    122181n.def([val])
     
    128187           val, if provided, is used to set the object default value
    129188    Code Example:
     189    {{{
     190        n = Rappture.Number()
     191        n.def()
     192        # ""
     193        n.def(300)
     194        n.def()
     195        # 300
     196    }}}
    130197
    131198n.cur([val])
     
    137204           val, if provided, is used to set the object current value
    138205    Code Example:
     206    {{{
     207        n = Rappture.Number()
     208        n.cur()
     209        # ""
     210        n.cur(450)
     211        n.cur()
     212        # 450
     213    }}}
    139214
    140215n.min([val])
     
    146221           val, if provided, is used to set the object min
    147222    Code Example:
     223    {{{
     224        n Rappture.Number()
     225        n.min()
     226        # ""
     227        n.min(0)
     228        n.min()
     229        # 0
     230    }}}
    148231
    149232n.max([val])
     
    155238           val, if provided, is used to set the object max
    156239    Code Example:
     240    {{{
     241        n = Rappture.Number()
     242        n.max()
     243        # ""
     244        n.max(500)
     245        n.max()
     246        # 500
     247    }}}
    157248
    158249n.units([val])
     
    164255           val, if provided, is used to set the object units
    165256    Code Example:
     257    {{{
     258        n = Rappture.Number()
     259        n.units()
     260        # ""
     261        n.units("K")
     262        n.units()
     263        # "K"
     264    }}}
    166265
    167266n.property(key[, val])
     
    173272    Notes: A copy val is stored in the property database
    174273    Code Example:
     274    {{{
     275        n = Rappture.Number()
     276        n.property("units")
     277        # ""
     278        n.property("units","K")
     279        # "K"
     280        n.units()
     281        # "K"
     282    }}}
    175283
    176284n.propremove(key)
     
    181289    Notes: None
    182290    Code Example:
     291    {{{
     292        n = Rappture.Number("temperature","K",300)
     293        n.property("units")
     294        # "K"
     295        n.propremove("units")
     296        # "K"
     297        n.property("units")
     298        # ""
     299    }}}
    183300
    184301n.convert(to)
     
    189306    Notes: the values stored in the object are changed
    190307    Code Example:
     308    {{{
     309        n = Rappture.Number("temperature","K",300)
     310        n.min("0K")
     311        n.max("500K")
     312        n.cur(450)
     313        out = n.convert("F")
     314        if (out.value() != 0) {
     315            sys.stderr.write(out.context())
     316            sys.stderr.write(out.remark())
     317        }
     318        n.min()
     319        # -459.67
     320        n.max()
     321        # 440.33
     322        n.def()
     323        # 80.33
     324        n.cur()
     325        # 350.33
     326    }}}
    191327
    192328n.value(to)
     
    200336            as the value.
    201337    Code Example:
     338    {{{
     339        n = Rappture.Number()
     340        n.value()
     341        # 0
     342        n.def(300)
     343        n.value()
     344        # 300
     345        n.cur(450)
     346        n.value()
     347        # 450
     348        n.value("F")
     349        # 350.33
     350    }}}
    202351
    203352n.vvalue([...])
     
    213362                hintKey=hintVal and be comma separated
    214363    Code Example:
     364    {{{
     365        n = Rappture.Number()
     366        n.cur(450)
     367        n.vvalue()
     368        # 450
     369        n.vvalue("units=F")
     370        # 350.33
     371    }}}
    215372
    216373n.random()
     
    222379           max if they were specified.
    223380    Code Example:
     381    {{{
     382        n = Rappture.Number()
     383        n.random()
     384        n.cur()
     385        # 1042.34
     386        # should be something more like:
     387        # n.configure(min=-30,max=30)
     388        # n.random()
     389        n.min(-30)
     390        n.max(30)
     391        n.random()
     392        n.cur()
     393        # 16.89
     394    }}}
    224395
    225396n.diff(o)
     
    231402    Notes: None
    232403    Code Example:
     404    {{{
     405        n1 = Rappture.Number("temperature","K",300,"0K","500K",
     406                                 "Ambiant Temperature",
     407                                 "Temperature of the environment")
     408        n2 = Rappture.Number("Ef","eV","4.5eV","0eV","10eV",
     409                                 "Fermi Level",
     410                                 "Energy at center of distribution")
     411        diffs = n1.diff(n2)
     412        # diffs is a list of tuples or list of lists
     413
     414        for ctype, prop, oVal, nVal in diffs {
     415            print ctype, prop, oVal, nVal
     416        }
     417        # c name temperature Ef
     418        # c units K eV
     419        # c def 300 4.5
     420        # c min 0 0
     421        # c max 500 10
     422        # c label "Ambiant Temperature" "Fermi Level"
     423        # c desc "Temperature of the environment" "Energy at center of distribution"
     424        #
     425        # Note that this function will find a difference in the
     426        # minimum values even though they are numerically equal.
     427        # This is because the objects have different units that
     428        # are not compatible. If compatible units were found,
     429        # n2's values would have been converted to n1's units
     430        # for each comparison.
     431    }}}
    233432
    234433n.addPreset(label, desc, val[, units])
     
    243442                in which they are created
    244443    Code Example:
     444    {{{
     445        n = Rappture.Number("temperature","K",300,"0K","500K",
     446                                "Ambiant Temperature",
     447                                "Temperature of the environment"]
     448        n.addPreset("Room Temperature","","300K")
     449        n.addPreset("Liquid Nitrogen","",77,"K")
     450        n.addPreset("Liquid Helium","","4.2K")
     451
     452        # 3 Presets stored in the Rappture.Number object
     453    }}}
    245454
    246455n.delPreset(label)
     
    251460    Notes: preset is removed from the object
    252461    Code Example:
     462    {{{
     463        n = Rappture.Number("temperature","K",300,"0K","500K",
     464                                "Ambiant Temperature",
     465                                "Temperature of the environment")
     466        n.addPreset("Room Temperature","","300K")
     467        n.addPreset("Liquid Nitrogen","",77,"K")
     468        n.addPreset("Liquid Helium","","4.2K")
     469
     470        n.delPreset("Liquid Helium")
     471        # 2 Presets stored in the Rappture.Number object
     472    }}}
    253473
    254474n.configure(as, c)
     
    267487    Notes: object is configured based on values in "c"
    268488    Code Example:
     489    {{{
     490        n = Rappture.Number()
     491        xmldata = """
     492            <?xml version="1.0">
     493            <number id="temperature">
     494                <about>
     495                    <label>Ambient temperature</label>
     496                    <description>Temperature of the environment.</description>
     497                </about>
     498                <units>K</units>
     499                <min>0K</min>
     500                <max>500K</max>
     501                <default>300K</default>
     502            </number>
     503        """
     504
     505        n.configure(RPCONFIG_XML,xmldata)
     506        n.name()
     507        # temperature
     508        n.label()
     509        # Ambient temperature
     510        n.desc()
     511        # Temperature of the environment.
     512        n.units()
     513        # K
     514        n.min()
     515        # 0
     516        n.max()
     517        # 500
     518        n.def()
     519        # 300
     520    }}}
    269521
    270522n.dump(as, c)
     
    283535    Notes: None
    284536    Code Example:
     537    {{{
     538        n = Rappture.Number("temperature","K",300,"0K","500K",
     539                                "Ambiant Temperature",
     540                                "Temperature of the environment")
     541        xmldata = n.dump(RPCONFIG_XML)
     542        print xmldata
     543
     544        # <number id="temperature">
     545        #     <about>
     546        #         <label>Ambient temperature</label>
     547        #         <description>Temperature of the environment.</description>
     548        #     </about>
     549        #     <units>K</units>
     550        #     <min>0K</min>
     551        #     <max>500K</max>
     552        #     <default>300K</default>
     553        # </number>
     554    }}}
    285555
    286556n.outcome()
     
    290560    Notes: None
    291561    Code Example:
     562    {{{
     563        n = Rappture.Number("temperature","K",300,"0K","500K",
     564                                "Ambiant Temperature",
     565                                "Temperature of the environment")
     566        out = n.outcome()
     567        if (out.value() != 0) {
     568            sys.stderr.write(out.context())
     569            sys.stderr.write(out.remark())
     570        }
     571    }}}
    292572
    293573n.is()
Note: See TracChangeset for help on using the changeset viewer.