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