stv0g/comedilib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc/funcref: Moved in comedi_set_global_oor_behavior

Browse source 
Moved function comedi_set_global_oor_behavior out of the deprecated
section as it is associated with the comedi_to_phys function.
This commit is contained in:
Ian Abbott 2012-05-11 12:34:31 +01:00
parent cda5011a87
commit 168fcd6ed6
2 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/deprecated_funcref.txt
View file

@ -31,23 +31,6 @@ Description:
and every device has the timer type <constant>nanosec_timer</constant>, indicating
that timer values are simply a time specified in nanoseconds.
Function: comedi_set_global_oor_behavior -- out-of-range behavior
Retval: int
Param: enum comedi_oor_behavior behavior
Status: deprecated
Description:
This function changes the Comedilib out-of-range behavior.
This currently affects the behavior of <function>comedi_to_phys</function> when
converting endpoint sample values, that is, sample values
equal to <literal>0</literal> or <parameter
class="function">maxdata</parameter>. If the out-of-range behavior is set to
<constant>COMEDI_OOR_NAN</constant>, endpoint values are converted to
<constant>NAN</constant>. If the
out-of-range behavior is set to <constant>COMEDI_OOR_NUMBER</constant>, the endpoint
values are converted similarly to other values.
The previous out-of-range behavior is returned.
Function: comedi_sv_init -- slowly-varying inputs
Retval: int
Param: comedi_sv_t * sv

17
doc/funcref
View file

@ -608,6 +608,23 @@ Description:
information, this function returns <literal>1</literal>. Otherwise, this function
returns <literal>0</literal>. On error, this function returns <literal>-1</literal>.
Function: comedi_set_global_oor_behavior -- out-of-range behavior
Retval: enum comedi_oor_behavior
Param: enum comedi_oor_behavior behavior
Description:
This function changes the Comedilib out-of-range behavior.
This currently affects the behavior of
<function>comedi_to_phys</function> when
converting endpoint sample values, that is, sample values
equal to <literal>0</literal> or <parameter
class="function">maxdata</parameter>. If the out-of-range behavior is set to
<constant>COMEDI_OOR_NAN</constant>, endpoint values are converted to
<constant>NAN</constant>. If the
out-of-range behavior is set to <constant>COMEDI_OOR_NUMBER</constant>, the endpoint
values are converted similarly to other values.
Returns:
The previous out-of-range behavior is returned.
Function: comedi_to_phys -- convert sample to physical units
Retval: double
Param: lsampl_t data