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