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