lin-epics-modules/pyDevSup
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update Field doc

Browse Source
This commit is contained in:
Michael Davidsaver
2015-06-11 16:40:43 -04:00
parent 7ac846141f
commit 0f2768fe2c
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
devsupApp/src/devsup/_nullapi.py
View File

@@ -140,20 +140,29 @@ class _Field(object):
"""
def getval(self):
"""Fetch the current field value as a scalar.
:rtype: int, float, or str
"""Fetch the current field value as a scalar or numpy.ndarray.
:rtype: int, float, str, or ndarray
Returned type depends of field DBF type.
An ``int`` is returned for CHAR, SHORT, LONG, and ENUM.
A ``float`` is returned for FLOAT and DOUBLE.
A ``str`` is returned for STRING.
A ``numpy.ndarray`` is returned for array fields.
This array is read-only and has the size of the present valid values.
.. important::
It is only safe to read this ndarray while the record
lock is held (ie within :meth:`process <DeviceSupport.process>`).
"""
def putval(self, val):
"""Update the field value
Must be an Int, Float or str. Strings will be truncated to 39 characters.
Must be an Int, Float, str, or numpy.ndarray.
Strings will be truncated to 39 characters.
Arrays must have a size less than or equal to the max element count.
Arrays are converted as necessary to the field's native type.
"""
def getarray(self):
@@ -164,7 +173,7 @@ class _Field(object):
.. important::
It is only safe to read or write to this ndarray while the record
lock is held (ie withing :meth:`process <DeviceSupport.process>`).
lock is held (ie within :meth:`process <DeviceSupport.process>`).
"""
def getarraylen(self):