1
- import { SuperMap } from '../SuperMap' ;
1
+ import { SuperMap } from '../SuperMap' ;
2
2
import { Util } from '../commontypes/Util' ;
3
3
4
4
/**
5
5
* @class SuperMap.AreaSolarRadiationParameters
6
- * @category iServer SpatialAnalyst SolarradiationAnalyst
6
+ * @category iServer SpatialAnalyst SolarRadiationAnalyst
7
7
* @classdesc 地区太阳辐射参数类。
8
- * @param options - {Object} 可选参数。如: </br>
9
- * dataset - {string} 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"的形式来表示,例如:JingjinTerrain@Jingjin。(必设参数) 。</br>
10
- * targetDatasourceName - {string} 指定的存储结果数据集的数据源名称(必设参数), 例如:"Jingjin"。</br>
11
- * totalGridName - {string} 指定地区太阳辐射总辐射量数据集的名称(必设参数)。</br>
12
- * diffuseDatasetGridName - {string} 指定地区太阳辐射散射辐射量数据集的名称。</br>
13
- * durationDatasetGridName - {string} 指定地区太阳辐射太阳直射持续时间数据集的名称。</br>
14
- * directDatasetGridName - {string} 指定地区太阳辐射直射辐射量数据集的名称。</br>
15
- * latitude - {number} 待计算区域的纬度值。</br>
16
- * timeMode - {string} 时间模式。可选值"WITHINDAY"(单日)或"MULTIDAYS"(多日),默认值为"MULTIDAYS" 。</br>
17
- * dayStart - {number} 起始日期(年内的第几天)。( 必设参数) </br>
18
- * dayEnd - {number} 结束日期(年内的第几天)。( 必设参数) </br>
19
- * hourStart - {number} 起始时间(一天中的第几个小时)。</br>
20
- * hourEnd - {number} 结束时间(一天中的第几个小时)。</br>
21
- * transmittance - {number} 太阳辐射穿过大气的透射率。</br>
22
- * hourInterval - {number} 计算时的小时间隔(设置的越小计算量越大并且计算结果更精确, 默认为0.5小时,如果修改此参数,必须使用整数)</br>
23
- * dayInterval - {number} 计算时的天数间隔(设置的越小计算量越大并且计算结果更精确, 默认为5天,必须使用整数)</br>
24
- * deleteExistResultDataset - {boolean} 如果用户命名的结果数据集名称与已有的数据集重名,是否删除已有的数据集。默认为 false,即不删除 。
8
+ * @param {Object } options - 参数。 </br>
9
+ * @param { string } options. dataset - 要用来做地区太阳辐射数据源中数据集的名称(必设参数) 。该名称用形如"数据集名称@数据源别名"的形式来表示,例如:JingjinTerrain@Jingjin。</br>
10
+ * @param {string } options.targetDatasourceName - 指定的存储结果数据集的数据源名称(必设参数), 例如:"Jingjin"。</br>
11
+ * @param { string } options. totalGridName - 指定地区太阳辐射总辐射量数据集的名称(必设参数)。</br>
12
+ * @param { string } options. diffuseDatasetGridName - 指定地区太阳辐射散射辐射量数据集的名称。</br>
13
+ * @param { string } options. durationDatasetGridName - 指定地区太阳辐射太阳直射持续时间数据集的名称。</br>
14
+ * @param { string } options. directDatasetGridName - 指定地区太阳辐射直射辐射量数据集的名称。</br>
15
+ * @param { number } options. latitude - 待计算区域的纬度值。</br>
16
+ * @param { string } [options.timeMode = "MULTIDAYS"] - 时间模式。可选值"WITHINDAY"(单日)或"MULTIDAYS"(多日)。</br>
17
+ * @param { number } options. dayStart - 起始日期(年内的第几天), 必设参数。 </br>
18
+ * @param { number } options. dayEnd - 结束日期(年内的第几天), 必设参数。 </br>
19
+ * @param { number } options. hourStart - 起始时间(一天中的第几个小时)。</br>
20
+ * @param { number } options. hourEnd - 结束时间(一天中的第几个小时)。</br>
21
+ * @param { number } options. transmittance - 太阳辐射穿过大气的透射率。</br>
22
+ * @param { number } [options. hourInterval=0.5] - 计算时的小时间隔(设置的越小计算量越大并且计算结果更精确, 默认为0.5小时,如果修改此参数,必须使用整数)。 </br>
23
+ * @param { number } [options. dayInterval=5] - 计算时的天数间隔(设置的越小计算量越大并且计算结果更精确, 默认为5天,必须使用整数)。 </br>
24
+ * @param { boolean } [options. deleteExistResultDataset=false] - 如果用户命名的结果数据集名称与已有的数据集重名,是否删除已有的数据集。
25
25
*/
26
26
export class AreaSolarRadiationParameters {
27
27
28
28
constructor ( options ) {
29
29
/**
30
- * @member SuperMap.AreaSolarRadiationParameters.prototype.dataset - {string}
31
- * @description 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示,例如:JingjinTerrain@Jingjin (必设参数) 。注:地区太阳辐射数据必须为栅格数据集。
30
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.dataset
31
+ * @description 要用来做地区太阳辐射数据源中数据集的名称(必设参数) 。该名称用形如"数据集名称@数据源别名"形式来表示,例如:JingjinTerrain@Jingjin。注:地区太阳辐射数据必须为栅格数据集。
32
32
*/
33
33
this . dataset = null ;
34
34
35
35
/**
36
- * @member SuperMap.AreaSolarRadiationParameters.prototype.targetDatasourceName - {string}
36
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.targetDatasourceName
37
37
* @description 指定的存储结果数据集的数据源名称(必设参数),例如:"Jingjin"。
38
38
*/
39
39
this . targetDatasourceName = null ;
40
40
41
41
/**
42
- * @member SuperMap.AreaSolarRadiationParameters.prototype.totalGridName - {string}
42
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.totalGridName
43
43
* @description 指定地区太阳辐射总辐射量数据集的名称(必设参数)。
44
44
*/
45
45
this . totalGridName = null ;
46
46
47
47
/**
48
- * @member SuperMap.AreaSolarRadiationParameters.prototype.diffuseDatasetGridName - {string}
48
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.diffuseDatasetGridName
49
49
* @description 指定地区太阳辐射散射辐射量数据集的名称。
50
50
*/
51
51
this . diffuseDatasetGridName = null ;
52
52
53
53
/**
54
- * @member SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName - {string}
54
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName
55
55
* @description 指定地区太阳辐射太阳直射持续时间数据集的名称。
56
56
*/
57
57
this . durationDatasetGridName = null ;
58
58
59
59
/**
60
- * @member SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName - {string}
60
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName
61
61
* @description 指定地区太阳辐射直射辐射量数据集的名称。
62
62
*/
63
63
this . directDatasetGridName = null ;
64
64
65
65
/**
66
- * @member SuperMap.AreaSolarRadiationParameters.prototype.latitude - {number}
66
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.latitude
67
67
* @description 待计算区域的纬度值。
68
68
*/
69
69
this . latitude = null ;
70
70
71
71
/**
72
- * @member SuperMap.AreaSolarRadiationParameters.prototype.timeMode - {string}
72
+ * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.timeMode
73
73
* @description 时间模式。可选值"WITHINDAY"(单日)或"MULTIDAYS"(多日),默认值为"MULTIDAYS";
74
74
*/
75
75
this . timeMode = "MULTIDAYS" ;
76
76
77
77
/**
78
- * @member SuperMap.AreaSolarRadiationParameters.prototype.dayStart - {number}
79
- * @description 起始日期(年内的第几天)。( 必设参数)
78
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayStart
79
+ * @description 起始日期(年内的第几天), 必设参数。
80
80
*/
81
81
this . dayStart = null ;
82
82
83
83
/**
84
- * @member SuperMap.AreaSolarRadiationParameters.prototype.dayEnd - {number}
85
- * @description 结束日期(年内的第几天)。( 必设参数)
84
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayEnd
85
+ * @description 结束日期(年内的第几天), 必设参数。
86
86
*/
87
87
this . dayEnd = null ;
88
88
89
89
/**
90
- * @member SuperMap.AreaSolarRadiationParameters.prototype.hourStart - {number}
90
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourStart
91
91
* @description 起始时间(一天中的第几个小时)。
92
92
*/
93
93
this . hourStart = null ;
94
94
95
95
/**
96
- * @member SuperMap.AreaSolarRadiationParameters.prototype.hourEnd - {number}
96
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourEnd
97
97
* @description 结束时间(一天中的第几个小时)。
98
98
*/
99
99
this . hourEnd = null ;
100
100
101
101
/**
102
- * @member SuperMap.AreaSolarRadiationParameters.prototype.transmittance - {number}
102
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.transmittance
103
103
* @description 太阳辐射穿过大气的透射率。
104
104
*/
105
105
this . transmittance = null ;
106
106
107
107
/**
108
- * @member SuperMap.AreaSolarRadiationParameters.prototype.hourInterval - {number}
108
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourInterval
109
109
* @description 计算时的小时间隔(设置的越小计算量越大并且计算结果更精确, 默认为0.5小时,如果修改此参数,必须使用整数)
110
110
*/
111
111
this . hourInterval = null ;
112
112
113
113
/**
114
- * @member SuperMap.AreaSolarRadiationParameters.prototype.dayInterval - {number}
114
+ * @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayInterval
115
115
* @description 计算时的天数间隔(设置的越小计算量越大并且计算结果更精确, 默认为5天,必须使用整数)
116
116
*/
117
117
this . dayInterval = null ;
118
118
119
119
/**
120
- * @member SuperMap.AreaSolarRadiationParameters.prototype.deleteExistResultDataset - {boolean}
120
+ * @member {boolean} SuperMap.AreaSolarRadiationParameters.prototype.deleteExistResultDataset
121
121
* @description 如果用户命名的结果数据集名称与已有的数据集重名,是否删除已有的数据集。默认为 false,即不删除。
122
122
*/
123
123
this . deleteExistResultDataset = false ;
@@ -143,9 +143,9 @@ export class AreaSolarRadiationParameters {
143
143
144
144
/**
145
145
* @function SuperMap.AreaSolarRadiationParameters.toObject
146
- * @param param - {SuperMap.AreaSolarRadiationParameters} 地区太阳辐射参数类。
147
- * @param tempObj - {SuperMap.AreaSolarRadiationParameters} 地区太阳辐射参数对象。
148
- * @return { object } JSON对象。
146
+ * @param {SuperMap.AreaSolarRadiationParameters } param - 地区太阳辐射参数类。
147
+ * @param {SuperMap.AreaSolarRadiationParameters } tempObj - 地区太阳辐射参数对象。
148
+ * @returns { Object } JSON对象。
149
149
* @description 将SuperMap.AreaSolarRadiationParameters对象转换成JSON对象。
150
150
*/
151
151
static toObject ( param , tempObj ) {
0 commit comments