API Scope.FindOutput - Revision history

JonnyW: XML import

2014-01-16T15:57:58Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:38Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:58:00Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:14Z

XML Import to change Variable types into Variable Types

JonnyW at 14:16, 29 May 2013

2013-05-29T14:16:47Z

JonnyW at 14:12, 29 May 2013

2013-05-29T14:12:50Z

JonnyW: /* Parameters */

2013-05-29T14:11:21Z

Parameters

JonnyW: /* Detailed description */

2013-05-29T14:11:08Z

Detailed description

JonnyW: XML import API changes

2013-05-14T13:15:35Z

XML import API changes

JonnyW: XML import API changes

2013-05-14T12:19:18Z

XML import API changes

New page

<sidebar>API contents</sidebar>
Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Scope|Scope]]
:[[API Scope|FindOutput]]
</div>
__TOC__

==Parameters==
[[Variable types|HANDLE]] ''StreamH''
:The stream that is to be read

[[Variable types|LONG]] ''TimeUS''
:The time offset to start the search from, in microseconds

[[Variable types|LONG]] ''SearchMax''
:The maximum number of microseconds to look back over, -ve to search backwards

[[Variable types|FLOAT]] ''Value''
:The target value to search for

[[Variable types|ULONG]] ''SearchFlags''
:Bit 0 is find lower, bit 1 is equal, 2 is find higher
:''Typical values for this parameter:''
::{| class="wikitable" width="65%"
|-
! width="30%" |Name
! width="55%" |Description
|-
|Find_Lower
|Match a search when output is lower than the target value
|-
|Find_Equal
|Match a search when output is equal to the target value
|-
|Find_Higher
|Match a search when output is greater than the target value
|-
|Find_LowHigh
|Match a search when output goes lower to higher than the target
|-
|Find_HighLow
|Match a search when output goes higher to lower than the target
|}

==Return value==
[[Variable types|LONG]]
Returns offset of found sample from TimeUS, 0 if not found

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* Declare a variable 'result' of type LONG
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.FindOutput(streamh, timeus, searchmax, value, ::Scope.Find_Lower)</pre>

''<span style="color:red;">No additional information</span>''

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found		Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found		Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found

← Older revision		Revision as of 14:12, 29 May 2013
Line 62:		Line 62:

	If the call fails to find a match then it will return 0 - an offset from the specified ''TimeUS'' which should otherwise not be returned.		If the call fails to find a match then it will return 0 - an offset from the specified ''TimeUS'' which should otherwise not be returned.
		+

	==Examples==		==Examples==

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found
@@ Line 70: / Line 72: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.FindOutput(streamh, timeus, searchmax, value, ::Scope.Find_Lower)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

@@ Line 10: / Line 10: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''StreamH''
+[[Variable Types|HANDLE]] ''StreamH''
 :The stream that is to be read
-[[Variable types|LONG]] ''TimeUS''
+[[Variable Types|LONG]] ''TimeUS''
 :The time offset to start the search from, in microseconds
-[[Variable types|LONG]] ''SearchMax''
+[[Variable Types|LONG]] ''SearchMax''
 :The maximum number of microseconds to look back over, -ve to search backwards
-[[Variable types|FLOAT]] ''Value''
+[[Variable Types|FLOAT]] ''Value''
 :The target value to search for
-[[Variable types|ULONG]] ''SearchFlags''
+[[Variable Types|ULONG]] ''SearchFlags''
 :A combination of flags to decide how to conduct the search
 :''Typical values for this parameter:''
@@ Line 48: / Line 48: @@
 ==Return value==
-[[Variable types|LONG]]
+[[Variable Types|LONG]]
 Returns offset of found sample from TimeUS, 0 if not found

@@ Line 45: / Line 45: @@
 |Match a search when output goes higher to lower than the target
 |}
 ==Return value==

@@ Line 54: / Line 54: @@
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+This call allows transitions in the stream to be detected.
 ==Examples==