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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
Debugging and Internals Access
------------------------------
.. seealso::
:hoc:func:`neuron.nrn_dll`
Namespace Related
~~~~~~~~~~~~~~~~~
.. hoc:function:: name_declared
Syntax:
``type = name_declared("name")``
``type = name_declared("name", 1)``
``type = name_declared("name", 2)``
Description:
Return 0 if the name is not in the symbol table. The first form looks
for names in the top level symbol table. The second form looks in the
current object context. The last form also looks in the top level
symbol table but is useful in Python to distinguish subtypes of
variables which appear as doubles in HOC but internally are really
not doubles and so cannot be pointed to by double*, eg. h.secondorder
which is <type 'int'> or h.nseg which returns either
``TypeError: Section access unspecified`` or
``nseg not a USERPROPERTY that can be pointed to``
If the name exists return
2 if an objref
3 if a Section
4 if a :ref:`strdef <hoc_keyword_strdef>`
5 if a scalar or :ref:`double <hoc_keyword_double>` variable. (if second arg is not 2)
if second arg is 2
5 if a scalar double
6 if a double array
7 if an integer
8 if a section property
1 otherwise
Note that names can be (re)declared only if they do not already
exist or are already of the same type.
This is too useful to require the user to waste an objref in creating a
:hoc:class:`StringFunctions` class to use :hoc:meth:`~StringFunctions.is_name`.
.. code-block::
none
name_declared("nrnmainmenu_")
{object_push(nrnmainmenu_) print name_declared("ldfile", 0) object_pop()}
{object_push(nrnmainmenu_) print name_declared("ldfile", 1) object_pop()}
----
.. hoc:function:: symbols
Name:
symbols --- type the names of HOC functions and variables
Syntax:
``symbols()``
Description:
Types a list of functions and variable names defined in HOC. Dimensions
of arrays are also indicated.
.. warning::
No longer works. The nearest replacement is :hoc:func:`SymChooser` .
Object Related
~~~~~~~~~~~~~~
.. hoc:function:: object_id
Syntax:
``object_id(objref)``
``object_id(objref, 1)``
Description:
Returns 0 if the object reference does not point to an object instance.
(Otherwise returns the pointer cast to a double, not a very useful number)
If the second argument is 1, it returns the index of the object name. Returns
-1 if the object is the NULLObject.
----
.. hoc:function:: allobjectvars
Syntax:
``allobjectvars()``
Description:
Prints all the object references (objref variables) that have been
declared along with the class type of the object they reference and the
number of references.
.. warning::
Instead of printing the address of the object in hex format, it ought
also to print the object_id and/or the internal instance name.
----
.. hoc:function:: allobjects
Syntax:
``allobjects()``
``allobjects("templatename")``
``nref = allobjects(objectref)``
Description:
Prints the internal names of all class instances (objects) available
from the interpreter along with the number of references to them.
With a templatename the list is restricted to objects of that class.
With an object variable, nothing is printed but the reference count
is returned. The count is too large by one if the argument was of the
form templatename[index] since a temporary reference is created while
the object is on the stack during the call.
----
.. hoc:function:: object_push
Syntax:
``object_push(objref)``
Description:
Enter the context of the object referenced by objref. In this context you
can directly access any variables or call any functions, even those not
declared as :ref:`public <hoc_keyword_public>`. Do not attempt to create any new symbol names!
This function is generally used by the object itself to save its state
in a session.
----
.. hoc:function:: object_pop
Syntax:
``object_pop()``
Description:
Pop the last object from an :hoc:func:`object_push` .
----
Miscellaneous
~~~~~~~~~~~~~
.. hoc:function:: hoc_pointer_
Syntax:
``hoc_pointer_(&variable)``
Description:
A function used by c and c++ implementations to request a pointer to
the variable from its interpreter name. Not needed by the user.
|
