/**
* <summary>
* Retrieves a compass function 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 compass function is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YCompass.isOnline()</c> to test if the compass function is
* indeed online at a given time. In case of ambiguity when looking for
* a compass function 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 compass function, for instance
* <c>Y3DMK002.compass</c>.
* </param>
* <returns>
* a <c>YCompass</c> object allowing you to drive the compass function.
* </returns>
*/
public static YCompass FindCompassInContext(YAPIContext yctx, string func)
{
YCompass obj;
obj = (YCompass)YFunction._FindFromCacheInContext(yctx, "Compass", func);
if (obj == null)
{
obj = new YCompass(yctx, func);
YFunction._AddToCache("Compass", func, obj);
}
return(obj);
}
/**
* <summary>
* Retrieves a compass function 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 compass function is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YCompass.isOnline()</c> to test if the compass function is
* indeed online at a given time. In case of ambiguity when looking for
* a compass function 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 compass function, for instance
* <c>Y3DMK002.compass</c>.
* </param>
* <returns>
* a <c>YCompass</c> object allowing you to drive the compass function.
* </returns>
*/
public static YCompass FindCompass(string func)
{
YCompass obj;
obj = (YCompass)YFunction._FindFromCache("Compass", func);
if (obj == null)
{
obj = new YCompass(func);
YFunction._AddToCache("Compass", func, obj);
}
return(obj);
}