优化API

songyumeng · songyumeng · commit c6aa02b9a294 · 2018-07-25T09:56:36.000+08:00
diff --git a/src/common/iServer/BurstPipelineAnalystParameters.js b/src/common/iServer/BurstPipelineAnalystParameters.js
@@ -7,8 +7,8 @@ import {Util} from '../commontypes/Util';
  * @classdesc 爆管分析参数类。
  * @param {Object} options - 参数。 
  * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点ID数组。 
- * @param {number} [options.edgeID] - 指定的弧段ID（注：edgeID 与 nodeID 不能同时使用）。 
- * @param {number} [options.nodeID] - 指定的结点ID（注：edgeID 与 nodeID 不能同时使用）。 
+ * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
+ * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。
  */
 export class BurstPipelineAnalystParameters {
@@ -24,13 +24,13 @@ export class BurstPipelineAnalystParameters {
 
         /**
          * @member {number} [SuperMap.BurstPipelineAnalystParameters.prototype.edgeID]
-         * @description 指定的弧段ID（注：edgeID 与 nodeID 不能同时使用）。
+         * @description 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.edgeID = null;
 
         /**
          * @member {number} [SuperMap.BurstPipelineAnalystParameters.prototype.nodeID]
-         * @description 指定的结点ID（注：edgeID 与 nodeID 不能同时使用）。
+         * @description 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.nodeID = null;
 
diff --git a/src/common/iServer/FacilityAnalyst3DParameters.js b/src/common/iServer/FacilityAnalyst3DParameters.js
@@ -9,8 +9,8 @@ import {Util} from '../commontypes/Util';
  * 超过 10 分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起
  * 作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
  * @param {Object} options - 参数。 
- * @param {number} [options.edgeID] - 指定的弧段 ID。 
- * @param {number} [options.nodeID] - 指定的结点 ID。 
+ * @param {number} [options.edgeID] - 指定的弧段 ID，edgeID 与 nodeID 必须指定一个。 
+ * @param {number} [options.nodeID] - 指定的结点 ID，edgeID 与 nodeID 必须指定一个。  
  * @param {string} options.weightName - 指定的权值字段信息对象的名称。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  *                                                      指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
@@ -21,13 +21,13 @@ export class FacilityAnalyst3DParameters {
     constructor(options) {
         /**
          * @member {number} [SuperMap.FacilityAnalyst3DParameters.prototype.edgeID]
-         * @description 指定的弧段ID。
+         * @description 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.edgeID = null;
 
         /**
          * @member {number} [SuperMap.FacilityAnalyst3DParameters.prototype.nodeID]
-         * @description 指定的结点ID。
+         * @description 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.nodeID = null;
 
diff --git a/src/common/iServer/FacilityAnalystSinks3DParameters.js b/src/common/iServer/FacilityAnalystSinks3DParameters.js
@@ -10,8 +10,8 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
  *            转向表、耗费等属性在最近设施分析时同样可设置。
  * @extends {SuperMap.FacilityAnalyst3DParameters}
  * @param {Object} options - 参数。 
- * @param {number} [options.edgeID] - 指定的弧段ID。 
- * @param {number} [options.nodeID] - 指定的结点ID。 
+ * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。  
+ * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。  
  * @param {string} options.weightName - 指定的权值字段信息对象的名称。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  * 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
diff --git a/src/common/iServer/FacilityAnalystSources3DParameters.js b/src/common/iServer/FacilityAnalystSources3DParameters.js
@@ -10,8 +10,8 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
  *            点、转向表、耗费等属性在最近设施分析时同样可设置。
  * @extends {SuperMap.FacilityAnalyst3DParameters}
  * @param {Object} options - 参数。 
- * @param {number} [options.edgeID] - 指定的弧段ID。
- * @param {number} [options.nodeID] - 指定的结点ID。 
+ * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
+ * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。  
  * @param {string} options.weightName - 指定的权值字段信息对象的名称。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  * 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
diff --git a/src/common/iServer/FacilityAnalystStreamParameters.js b/src/common/iServer/FacilityAnalystStreamParameters.js
@@ -6,9 +6,9 @@ import {Util} from '../commontypes/Util';
  * @category iServer NetworkAnalyst UpstreamCriticalFacilities
  * @classdesc 上游/下游关键设施查找资源参数类。
  * @param {Object} options - 参数。 
- * @param {Array.<number>} [options.sourceNodeIDs] - 指定的设施点ID数组，可以为空。 
- * @param {number} [options.edgeID] - 指定的弧段ID（注：edgeID 与 nodeID 不能同时使用）。 
- * @param {number} [options.nodeID] - 指定的结点ID（注：edgeID 与 nodeID 不能同时使用）。 
+ * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点ID数组。 
+ * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。  
+ * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。  
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。
  * @param {number} options.queryType - 分析类型，只能是 0 (上游关键设施查询) 或者是 1（下游关键设施查询）。
  */
@@ -18,19 +18,19 @@ export class FacilityAnalystStreamParameters {
     constructor(options) {
         /**
          * @member {Array.<number>} [SuperMap.FacilityAnalystStreamParameters.prototype.sourceNodeIDs]
-         * @description 指定的设施点ID数组，可以为空。
+         * @description 指定的设施点ID数组。
          */
         this.sourceNodeIDs = null;
 
         /**
          * @member {number} [SuperMap.FacilityAnalystStreamParameters.prototype.edgeID]
-         * @description 指定的弧段ID（注：edgeID 与 nodeID 不能同时使用）。
+         * @description 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.edgeID = null;
 
         /**
          * @member {number} [SuperMap.FacilityAnalystStreamParameters.prototype.nodeID]
-         * @description 指定的结点ID（注：edgeID 与 nodeID 不能同时使用）。
+         * @description 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.nodeID = null;
 
diff --git a/src/common/iServer/FacilityAnalystTraceup3DParameters.js b/src/common/iServer/FacilityAnalystTraceup3DParameters.js
@@ -7,8 +7,8 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
  * @classdesc 上游追踪资源参数类。
  * @extends {SuperMap.FacilityAnalyst3DParameters}
  * @param {Object} options - 参数。 
- * @param {number} [options.edgeID] - 指定的弧段ID。 
- * @param {number} [options.nodeID] - 指定的结点ID。 
+ * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
+ * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
  * @param {string} options.weightName - 指定的权值字段信息对象的名称。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  * 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
diff --git a/src/common/iServer/FacilityAnalystUpstream3DParameters.js b/src/common/iServer/FacilityAnalystUpstream3DParameters.js
@@ -8,23 +8,18 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
  * @classdesc 上游关键设施查找资源参数类。
  * @extends {SuperMap.FacilityAnalyst3DParameters}
  * @param {Object} options - 参数。 
- * @param {number} [options.edgeID] - 指定的弧段ID。 
- * @param {number} [options.nodeID] - 指定的结点ID。 
- * @param {string} [options.weightName] - 指定的权值字段信息对象的名称。 
+ * @param {number} [options.edgeID] - 指定的弧段ID。edgeID 与 nodeID 必须指定一个。  
+ * @param {number} [options.nodeID] - 指定的结点ID。edgeID 与 edgeID 必须指定一个。
+ * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点ID数组。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  * 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。 
- * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点ID数组。
  */
 export class FacilityAnalystUpstream3DParameters extends FacilityAnalyst3DParameters {
 
 
     constructor(options) {
         super(options);
         options = options || {};
-        /**
-         * @member {Array.<number>} SuperMap.FacilityAnalystUpstream3DParameters.prototype.sourceNodeIDs
-         * @description 指定的设施点ID数组。
-         */
         this.sourceNodeIDs = null;
         Util.extend(this, options);
         this.CLASS_NAME = "SuperMap.FacilityAnalystUpstream3DParameters";
