fix: 规约修改over

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/auto/initial/ApplicationAutoInitial.java

@@ -11,7 +11,7 @@ package org.nl.acs.auto.initial;
  */
 public interface ApplicationAutoInitial {
     /**
-     *
+     * 执行实现的autoInitial方法
      * @throws Exception
      */
     void autoInitial() throws Exception;

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/auto/initial/ApplicationAutoInitialExecuter.java

@@ -37,7 +37,8 @@ public class ApplicationAutoInitialExecuter {
 
         while (it.hasNext()) {
             ApplicationAutoInitial service = (ApplicationAutoInitial) it.next();
-            service.autoInitial(); // 执行实现的autoInitial方法
+            // 执行实现的autoInitial方法
+            service.autoInitial();
         }
 
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/auto/initial/WebAutoInitial.java

@@ -7,7 +7,7 @@ package org.nl.acs.auto.initial;
  */
 public interface WebAutoInitial {
     /**
-     *
+     * autoInitial
      * @throws Exception
      */
     void autoInitial() throws Exception;

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/auto/run/AbstractAutoRunnable.java

@@ -71,10 +71,10 @@ public abstract class AbstractAutoRunnable implements Runnable {
     public String getDescription() {
         return this.getName();
     }
+
     /**
-     *autoRun
+     * autoRun
-     * @return autoRun
+     * @throws Exception
-     * @throws
      */
     public abstract void autoRun() throws Exception;
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/DeviceDriver.java

@@ -9,16 +9,37 @@ import java.util.ArrayList;
 import java.util.List;
 
 public interface DeviceDriver {
+    /**
+     * getDeviceCode
+     * @return
+     */
     default String getDeviceCode() {
         return this.getDevice().getDevice_code();
     }
 
+    /**
+     * getDevice
+     * @return
+     */
     Device getDevice();
 
+    /**
+     * getDriverDefination
+     * @return
+     */
     DeviceDriverDefination getDriverDefination();
 
+    /**
+     * setDriverDefination
+     * @param var1
+     * @return
+     */
     DeviceDriver setDriverDefination(DeviceDriverDefination var1);
 
+    /**
+     * getDriverDefinationCode
+     * @return
+     */
     default String getDriverDefinationCode() {
         return this.getDriverDefination().getDriverCode();
     }
@@ -43,6 +64,11 @@ public interface DeviceDriver {
         return devicesList;
     }
 
+    /**
+     * getModeName
+     * @param mode
+     * @return
+     */
     default String getModeName(String mode) {
         if (StrUtil.equals("0", mode)) {
             mode = "脱机";

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/DeviceDriverDefination.java

@@ -6,15 +6,40 @@ import org.nl.acs.device.enums.DeviceType;
 import java.util.List;
 
 public interface DeviceDriverDefination {
+    /**
+     * getDriverCode
+     * @return
+     */
     String getDriverCode();
 
+    /**
+     * getDriverName
+     * @return
+     */
     String getDriverName();
 
+    /**
+     * getDriverDescription
+     * @return
+     */
     String getDriverDescription();
 
+    /**
+     * getDriverInstance
+     * @param device
+     * @return
+     */
     DeviceDriver getDriverInstance(Device device);
 
+    /**
+     * getDeviceDriverType
+     * @return
+     */
     Class<? extends DeviceDriver> getDeviceDriverType();
 
+    /**
+     * getFitDeviceTypes
+     * @return
+     */
     List<DeviceType> getFitDeviceTypes();
 }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/HeartbeatableDeviceDriver.java

@@ -4,6 +4,10 @@ public interface HeartbeatableDeviceDriver extends DeviceDriver {
     default void checkHeartbeat() {
     }
 
+    /**
+     * isOnline
+     * @return
+     */
     default boolean isOnline() {
         return false;
     }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/RouteableDeviceDriver.java

@@ -1,10 +1,18 @@
 package org.nl.acs.device_driver;
 
 public interface RouteableDeviceDriver extends DeviceDriver {
+    /**
+     * isEntrance
+     * @return
+     */
     default boolean isEntrance() {
         return this.getDevice().getIs_entrance();
     }
 
+    /**
+     * isExist
+     * @return
+     */
     default boolean isExist() {
         return this.getDevice().getIs_exist();
     }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/ScannerDeviceDriver.java

@@ -1,9 +1,20 @@
 package org.nl.acs.device_driver;
 
 public interface ScannerDeviceDriver extends DeviceDriver {
+    /**
+     * writeBarcode
+     * @param var1
+     */
     void writeBarcode(String var1);
 
+    /**
+     * cleanBarcode
+     */
     void cleanBarcode();
 
+    /**
+     * readBarcode
+     * @return
+     */
     String readBarcode();
 }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/StorageDeviceDriver.java

@@ -4,26 +4,50 @@ import java.util.ArrayList;
 import java.util.List;
 
 public interface StorageDeviceDriver extends DeviceDriver {
+    /**
+     * getConfigForbidFront
+     * @return
+     */
     default List<Integer> getConfigForbidFront() {
         return new ArrayList();
     }
 
+    /**
+     * getConfigCantFront
+     * @return
+     */
     default List<Integer> getConfigCantFront() {
         return new ArrayList();
     }
 
+    /**
+     * getConfigCantBack
+     * @return
+     */
     default List<Integer> getConfigCantBack() {
         return new ArrayList();
     }
 
+    /**
+     * getConfigForbidFrontLocation
+     * @return
+     */
     default List<String> getConfigForbidFrontLocation() {
         return new ArrayList();
     }
 
+    /**
+     * getConfigCantFrontLocation
+     * @return
+     */
     default List<String> getConfigCantFrontLocation() {
         return new ArrayList();
     }
 
+    /**
+     * getConfigCantBackLocation
+     * @return
+     */
     default List<String> getConfigCantBackLocation() {
         return new ArrayList();
     }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/agv/utils/IAgv.java

@@ -1,5 +1,10 @@
 package org.nl.acs.device_driver.agv.utils;
 
 public interface IAgv {
+    /**
+     * 获取phase名称
+     * @param phase
+     * @return
+     */
     String getPhaseName(Integer phase);
 }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/defination/OpcDeviceDriverDefination.java

@@ -6,7 +6,15 @@ import org.nl.acs.device_driver.DeviceDriverDefination;
 import java.util.List;
 
 public interface OpcDeviceDriverDefination extends DeviceDriverDefination {
+    /**
+     * getReadableItemDtos
+     * @return
+     */
     List<ItemDto> getReadableItemDtos();
 
+    /**
+     * getWriteableItemDtos
+     * @return
+     */
     List<ItemDto> getWriteableItemDtos();
 }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/driver/ExecutableDeviceDriver.java

@@ -3,6 +3,10 @@ package org.nl.acs.device_driver.driver;
 import org.nl.acs.device_driver.DeviceDriver;
 
 public interface ExecutableDeviceDriver extends DeviceDriver {
+    /**
+     * executeAuto
+     * @throws Exception
+     */
     default void executeAuto() throws Exception {
 //    try {
 //      this.execute();
@@ -15,5 +19,9 @@ public interface ExecutableDeviceDriver extends DeviceDriver {
 
     }
 
+    /**
+     * execute
+     * @throws Exception
+     */
     void execute() throws Exception;
 }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/device_driver/driver/OpcDeviceDriver.java

@@ -21,10 +21,18 @@ import java.util.List;
 import java.util.Map;
 
 public interface OpcDeviceDriver extends DeviceDriver {
+    /**
+     * getOpcValueAccessor
+     * @return
+     */
     UnifiedDataAccessor getOpcValueAccessor();
 
     DeviceExtraMapper deviceExtraMapper = SpringContextHolder.getBean("deviceExtraMapper");
 
+    /**
+     * getOpcItems
+     * @return
+     */
     default List<OpcItemDto> getOpcItems() {
 
         List<OpcItemDto> returns = new ArrayList();
@@ -54,38 +62,78 @@ public interface OpcDeviceDriver extends DeviceDriver {
         return returns;
     }
 
+    /**
+     * getExtraValue
+     * @return
+     */
     default Map<String, Object> getExtraValue() {
         return this.getDevice().getExtraValue();
     }
 
+    /**
+     * getOpcServer
+     * @return
+     */
     default String getOpcServer() {
         return this.getDevice().getOpc_server_code();
     }
 
+    /**
+     * getDevice
+     * @return
+     */
     @Override
     Device getDevice();
 
-
+    /**
+     * getOpcPlc
+     * @return
+     */
     default String getOpcPlc() {
         return this.getDevice().getOpc_plc_code();
     }
 
+    /**
+     * getIntegeregerValue
+     * @param protocol
+     * @return
+     */
     default Integer getIntegeregerValue(String protocol) {
         return (Integer) this.getValue(protocol);
     }
 
+    /**
+     * getStringgerValue
+     * @param protocol
+     * @return
+     */
     default String getStringgerValue(String protocol) {
         return (String) this.getValue(protocol);
     }
 
+    /**
+     * getLongValue
+     * @param protocol
+     * @return
+     */
     default Long getLongValue(String protocol) {
         return (Long) this.getValue(protocol);
     }
 
+    /**
+     * getByteArrayValue
+     * @param protocol
+     * @return
+     */
     default Byte[] getByteArrayValue(String protocol) {
         return (Byte[]) this.getValue(protocol);
     }
 
+    /**
+     * getIntegerArrayValue
+     * @param protocol
+     * @return
+     */
     default int[] getIntegerArrayValue(String protocol) {
         return (int[]) this.getValue(protocol);
     }
@@ -100,34 +148,74 @@ public interface OpcDeviceDriver extends DeviceDriver {
 //        return (Float) this.getValue(protocol);
     }
 
+    /**
+     * getFloatValue
+     * @param protocol
+     * @return
+     */
     default Float getFloatValue(String protocol) {
         return (Float) this.getOpcValueAccessor().getValue(this.getItem(protocol));
     }
 
+    /**
+     * getIntegerValue
+     * @param protocol
+     * @return
+     */
     default Integer getIntegerValue(String protocol) {
         return (Integer) this.getValue(protocol);
     }
 
+    /**
+     * getShortValue
+     * @param protocol
+     * @return
+     */
     default Short getShortValue(String protocol) {
         return (Short) this.getOpcValueAccessor().getValue(this.getItem(protocol));
     }
 
+    /**
+     * getIntegeregerArrayValue
+     * @param protocol
+     * @return
+     */
     default int[] getIntegeregerArrayValue(String protocol) {
         return (int[]) this.getOpcValueAccessor().getValue(this.getItem(protocol));
     }
 
+    /**
+     * getStringValue
+     * @param protocol
+     * @return
+     */
     default String getStringValue(String protocol) {
         return this.getOpcValueAccessor().getValue(this.getItem(protocol)).toString();
     }
 
+    /**
+     * getValue
+     * @param protocol
+     * @return
+     */
     default Object getValue(String protocol) {
         return this.getOpcValueAccessor().getValue(this.getItem(protocol));
     }
 
+    /**
+     * getItem
+     * @param item
+     * @return
+     */
     default String getItem(String item) {
         return this.getOpcServer() + "." + this.getOpcPlc() + "." + this.getDeviceCode() + "." + item;
     }
 
+    /**
+     * getUdwValue
+     * @param protocol
+     * @return
+     */
     default Object getUdwValue(String protocol) {
         return this.getOpcValueAccessor().getValue(protocol);
     }

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/ext/wms/service/AcsToLiKuService.java

@@ -9,7 +9,12 @@ import org.nl.acs.instruction.domain.Instruction;
  */
 public interface AcsToLiKuService {
 
-
+    /**
+     * sendInst
+     * @param type
+     * @param inst
+     * @return
+     */
     public Resp sendInst(String type, Instruction inst);
 
     /**
@@ -65,7 +70,7 @@ public interface AcsToLiKuService {
 
     /**
      * 巷道锁定与解锁
-     *
+     * @param requestParam
      * @return
      */
     public Resp<RoadWayIsLockResponse> roadWayIsLock(RoadWayIsLockRequest requestParam);
@@ -73,28 +78,28 @@ public interface AcsToLiKuService {
 
     /**
      * 取消任务
-     *
+     * @param requestParam
      * @return
      */
     public Resp<CancelTaskResponse> cancelTask(CancelTaskRequest requestParam);
 
     /**
      * 查询小车设备状态
-     *
+     * @param requestParam
      * @return
      */
     public Resp<DeviceStatusResponse> queryCarDeviceStatus(DeviceStatusRequest requestParam);
 
     /**
      * 查询tsj设备状态
-     *
+     * @param requestParam
      * @return
      */
     public Resp<DeviceStatusResponse> queryTsjDeviceStatus(DeviceStatusRequest requestParam);
 
     /**
      * 查询ssx设备状态
-     *
+     * @param requestParam
      * @return
      */
     public Resp<DeviceStatusResponse> querySsxDeviceStatus(DeviceStatusRequest requestParam);

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/ext/wms/service/AcsToWmsService.java

@@ -9,17 +9,25 @@ public interface AcsToWmsService {
 
     /**
      * ACS向WMS申请任务
+     * @param jo
+     * @return
      */
     String applyTaskToWms(JSONObject jo);
 
     /**
      * 向WMS反馈任务状态
-     *
+     * @param arr
-     * @return Map<String, Object>
+     * @return
      */
     public HttpResponse feedbackTaskStatusToWms(JSONArray arr);
 
-
+    /**
+     * 请求任务
+     * @param address
+     * @param task_id
+     * @param vehicle_code
+     * @return
+     */
     public String requestTaskAgain(String address, String task_id, String vehicle_code);
 
     /**
@@ -84,16 +92,22 @@ public interface AcsToWmsService {
 
     /**
      * ACS向WMS申请任务
+     * @param request
+     * @return
      */
     String applyTask(BaseRequest request);
 
     /**
      * ACS向WMS反馈任务状态
+     * @param request
+     * @return
      */
     String feedTaskStatus(BaseRequest request);
 
     /**
      * ACS向WMS反馈任务状态
+     * @param request
+     * @return
      */
     String notify(BaseRequest request);
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/ext/wms/service/LiKuToAcsService.java

@@ -10,9 +10,9 @@ public interface LiKuToAcsService {
 
     /**
      * 入库任务上报
-     *
      * @param requestParam
      * @return
+     * @throws Exception
      */
     public Resp<InStoreReportResponse> inStoreReport(InStoreReportRequest requestParam) throws Exception;
 
@@ -21,6 +21,7 @@ public interface LiKuToAcsService {
      *
      * @param requestParam
      * @return
+     * @throws Exception
      */
     public Resp<OutStoreReportResponse> outStoreReport(OutStoreReportRequest requestParam) throws Exception;
 
@@ -29,6 +30,7 @@ public interface LiKuToAcsService {
      *
      * @param requestParam
      * @return
+     * @throws Exception
      */
     public Resp<MoveStoreReportResponse> moveStoreReport(MoveStoreReportRequest requestParam) throws Exception;
 
@@ -38,6 +40,7 @@ public interface LiKuToAcsService {
      *
      * @param requestParam
      * @return
+     * @throws Exception
      */
     public Resp<DeviceStatusResponse> putEmptyPallet(putEmptyPalletRequest requestParam) throws Exception;
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/ext/wms/service/WmsToAcsService.java

@@ -8,7 +8,11 @@ import java.util.List;
 import java.util.Map;
 
 public interface WmsToAcsService {
-
+    /**
+     * crateTask
+     * @param param
+     * @return
+     */
     org.nl.acs.ext.wms.data.CreateTaskResponse crateTask(String param);
 
     /**
@@ -22,8 +26,9 @@ public interface WmsToAcsService {
 
     /**
      * 取消任务
-     *
+     * @param reqs
-     * @param reqs 条件
+     * @return
+     * @throws Exception
      */
     CancelTaskResponse cancelFromWms(List<CancelTaskRequest> reqs) throws Exception;
 
@@ -45,9 +50,9 @@ public interface WmsToAcsService {
 
     /**
      * 下发动作
-     *
+     * @param jsonObject
-     * @param jsonObject 条件
+     * @return
-     * @return Map<String, Object>
+     * @throws Exception
      */
     org.nl.acs.ext.wms.data.PutActionResponse putAction(String jsonObject) throws Exception;
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/route/service/RouteLocService.java

@@ -63,23 +63,23 @@ public interface RouteLocService extends CommonService<RouteLoc> {
     int insert(RouteLocDto resources);
 
     /**
-     * 编辑数据
+     * updateById
-     *
+     * @param resources
-     * @param resources /
+     * @return
      */
     int updateById(RouteLocDto resources);
 
     /**
      * 删除数据
-     *
+     * @param id
-     * @param id ID
+     * @return
      */
     int removeById(String id);
 
     /**
      * 批量删除数据
-     *
+     * @param ids
-     * @param ids ID集合
+     * @return
      */
     int removeByIds(Set<String> ids);
 

acs/nladmin-system/nlsso-server/src/main/java/org/nl/acs/route/service/RoutePlanService.java

@@ -65,22 +65,22 @@ public interface RoutePlanService extends CommonService<RoutePlan> {
 
     /**
      * 修改数据
-     *
+     * @param resources
-     * @param resources /
+     * @return
      */
     int updateById(RoutePlanDto resources);
 
     /**
      * 删除数据
-     *
+     * @param id
-     * @param id ID
+     * @return
      */
     int removeById(String id);
 
     /**
      * 批量删除数据
-     *
+     * @param ids
-     * @param ids ID集合
+     * @return
      */
     int removeByIds(Set<String> ids);