/**
* <summary>
* Retrieves a range finder for a given identifier in a YAPI context.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* 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 <c>YRangeFinder.isOnline()</c> 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.
* </para>
* </summary>
* <param name="yctx">
* a YAPI context
* </param>
* <param name="func">
* a string that uniquely characterizes the range finder
* </param>
* <returns>
* a <c>YRangeFinder</c> object allowing you to drive the range finder.
* </returns>
*/
public static YRangeFinder FindRangeFinderInContext(YAPIContext yctx, string func)
{
YRangeFinder obj;
obj = (YRangeFinder)YFunction._FindFromCacheInContext(yctx, "RangeFinder", func);
if (obj == null)
{
obj = new YRangeFinder(yctx, func);
YFunction._AddToCache("RangeFinder", func, obj);
}
return(obj);
}
/**
* <summary>
* Retrieves a range finder for a given identifier.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* 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 <c>YRangeFinder.isOnline()</c> 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.
* </para>
* <para>
* 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.
* </para>
* <para>
* </para>
* </summary>
* <param name="func">
* a string that uniquely characterizes the range finder
* </param>
* <returns>
* a <c>YRangeFinder</c> object allowing you to drive the range finder.
* </returns>
*/
public static YRangeFinder FindRangeFinder(string func)
{
YRangeFinder obj;
obj = (YRangeFinder)YFunction._FindFromCache("RangeFinder", func);
if (obj == null)
{
obj = new YRangeFinder(func);
YFunction._AddToCache("RangeFinder", func, obj);
}
return(obj);
}