Yoctopuce Yocto-RangeFinder, User Manual, Page: 239 / 497

21. High-level API Reference
YRangeFinder YRangeFinder.FindRangeFinder()
yFindRangeFinder()
Retrieves a range finder for a given identifier.
js
function yFindRangeFinder( func )
cpp
YRangeFinder* yFindRangeFinder( string func )
m
+(YRangeFinder*) FindRangeFinder : (NSString*) func
pas
function yFindRangeFinder( func : string): TYRangeFinder
vb
function yFindRangeFinder( ByVal func As String) As YRangeFinder
cs
YRangeFinder FindRangeFinder( string func )
java
YRangeFinder FindRangeFinder( String func )
uwp
YRangeFinder FindRangeFinder( string func )
py
def FindRangeFinder( func )
php
function yFindRangeFinder( $func )
es
function FindRangeFinder( func )
The identifier can be specified using several formats:
FunctionLogicalName
●
ModuleSerialNumber.FunctionIdentifier
●
ModuleSerialNumber.FunctionLogicalName
●
ModuleLogicalName.FunctionIdentifier
●
ModuleLogicalName.FunctionLogicalName
●
This function does not require that the range finder is online at the time it is invoked. The returned
object is nevertheless valid. Use the method
YRangeFinder.isOnline()
to test if the range finder
is indeed online at a given time. In case of ambiguity when looking for a range finder by logical name,
no error is notified: the first instance found is returned. The search is performed first by hardware name,
then by logical name. If a call to this object's is_online() method returns FALSE although you are certain
that the matching device is plugged, make sure that you did call registerHub() at application initialization
time.
Parameters :
func a string that uniquely characterizes the range finder
Returns :
a
YRangeFinder
object allowing you to drive the range finder.
www.yoctopuce.com 233