File: nfunc.rst

package info (click to toggle)
neuron 8.2.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,760 kB
  • sloc: cpp: 149,571; python: 58,465; ansic: 50,329; sh: 3,510; xml: 213; pascal: 51; makefile: 35; sed: 5
file content (88 lines) | stat: -rwxr-xr-x 2,074 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.. _nfunc:

Miscellaneous Menus
-------------------



.. function:: nrnglobalmechmenu


    Syntax:
        ``h.nrnglobalmechmenu("mechname")``

        ``n = h.nrnglobalmechmenu("mechname", 0)``


    Description:
        pops up panel containing all global variables defined by the 
        mechanism. 
         
        :samp:`h.nrnglobalmechmenu("{mechname}", 0)` returns the number of global variables 
        for this mechanism. Does not pop up a panel. 
         


----



.. function:: nrnmechmenu

        vestigial. does nothing. taken over by :func:`nrnsecmenu` 

----



.. function:: nrnpointmenu

         

    Syntax:
        ``h.nrnpointmenu(PointProcessObject)``

        ``h.nrnpointmenu(PointProcessObject, labelstyle)``


    Description:
        Pops up panel containing all variables of the point process. 
        if the point process is relocated to another position then the 
        label will be incorrect and the window should be dismissed and 
        recreated. 
         
        If the second arg exists,  a value of -1 means to not prepend 
        a label. 0 means to use the Object name as the label. 1 (default) 
        means to use the object name along with location when the panel was 
        created. 

         

----



.. function:: nrnsecmenu


    Syntax:
        ``h.nrnsecmenu(x, vartype, sec=section)``


    Description:
        Pop up a panel containing variables in the ``section``. 
         
        0 < x < 1 shows variables at segment containing x 
        changing these variables changes only the values in that segment 
        eg. equivalent to :samp:`section.v(.2) = -65`
         
        x = -1 shows range variables which are constant (same in 
        each segment  of the section). 
        changing these variables makes the variable constant in the 
        entire section. eg. equivalent to section.v = -65. 
        Variables that are not constant get a label to that effect 
        instead of a field editor. 
         
        vartype=1,2,3 shows parameters, assigned, or states respectively.