← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to docs/symbols/src/lib_helioviewer_Config.js.html

Modified back-end directory structure and naming conventions. Now using PEAR's naming convention for classes. Tests should be created in mirror sub-directory within the "tests" folder.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/symbols/src/lib_helioviewer_Config.js.html
1
 
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style>
2
 
        .KEYW {color: #933;}
3
 
        .COMM {color: #bbb; font-style: italic;}
4
 
        .NUMB {color: #393;}
5
 
        .STRN {color: #393;}
6
 
        .REGX {color: #339;}
7
 
        .line {border-right: 1px dotted #666; color: #666; font-style: normal;}
8
 
        </style></head><body><pre><span class='line'>  1</span> <span class="COMM">/**
9
 
<span class='line'>  2</span>  * @author &lt;a href="mailto:keith.hughitt@nasa.gov">Keith Hughitt&lt;/a> 
10
 
<span class='line'>  3</span>  * @fileOverview This class handles the creation and validation of basic configuration parameters
11
 
<span class='line'>  4</span>  */</span><span class="WHIT">
12
 
<span class='line'>  5</span> </span><span class="COMM">/*jslint browser: true, white: true, onevar: true, undef: true, nomen: false, eqeqeq: true, plusplus: true, 
13
 
<span class='line'>  6</span> bitwise: true, regexp: true, strict: true, newcap: true, immed: true, maxlen: 120, sub: true */</span><span class="WHIT">
14
 
<span class='line'>  7</span> </span><span class="COMM">/*global Class, $, window */</span><span class="WHIT">
15
 
<span class='line'>  8</span> </span><span class="STRN">"use strict"</span><span class="PUNC">;</span><span class="WHIT">
16
 
<span class='line'>  9</span> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">Config</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Class.extend</span><span class="PUNC">(</span><span class="WHIT">
17
 
<span class='line'> 10</span> </span><span class="WHIT">    </span><span class="COMM">/** @lends Config.prototype */</span><span class="WHIT">
18
 
<span class='line'> 11</span> </span><span class="WHIT">    </span><span class="PUNC">{</span><span class="WHIT">
19
 
<span class='line'> 12</span> </span><span class="WHIT">    </span><span class="COMM">/**
20
 
<span class='line'> 13</span>      * @description Creates a new Config. 
21
 
<span class='line'> 14</span>      * @constructs 
22
 
<span class='line'> 15</span>      */</span><span class="WHIT"> 
23
 
<span class='line'> 16</span>     </span><span class="NAME">init</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">params</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
24
 
<span class='line'> 17</span> </span><span class="WHIT">        </span><span class="NAME">this.params</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">params</span><span class="PUNC">;</span><span class="WHIT">
25
 
<span class='line'> 18</span> </span><span class="WHIT">        
26
 
<span class='line'> 19</span>         </span><span class="NAME">this.bools</span><span class="WHIT">  </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="PUNC">[</span><span class="STRN">"distributed_tiling_enabled"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"backup_enabled"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"disable_cache"</span><span class="PUNC">]</span><span class="PUNC">;</span><span class="WHIT">
27
 
<span class='line'> 20</span> </span><span class="WHIT">        </span><span class="NAME">this.ints</span><span class="WHIT">   </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="PUNC">[</span><span class="STRN">"build_num"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"default_zoom_level"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"default_timestep"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"min_zoom_level"</span><span class="PUNC">,</span><span class="WHIT">  
28
 
<span class='line'> 21</span>                        </span><span class="STRN">"max_zoom_level"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"prefetch_size"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"png_compression_quality"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"jpeg_compression_quality"</span><span class="PUNC">,</span><span class="WHIT">    
29
 
<span class='line'> 22</span>                        </span><span class="STRN">"bit_depth"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"num_colors"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"tile_pad_width"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"max_movie_frames"</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="STRN">"base_zoom_level"</span><span class="PUNC">]</span><span class="PUNC">;</span><span class="WHIT">
30
 
<span class='line'> 23</span> </span><span class="WHIT">        </span><span class="NAME">this.floats</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="PUNC">[</span><span class="STRN">"base_image_scale"</span><span class="PUNC">]</span><span class="PUNC">;</span><span class="WHIT">
31
 
<span class='line'> 24</span> </span><span class="WHIT">        
32
 
<span class='line'> 25</span>         </span><span class="NAME">this.fixTypes</span><span class="PUNC">(</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
33
 
<span class='line'> 26</span> </span><span class="WHIT">    </span><span class="PUNC">}</span><span class="PUNC">,</span><span class="WHIT">
34
 
<span class='line'> 27</span> </span><span class="WHIT">    
35
 
<span class='line'> 28</span>     </span><span class="COMM">/**
36
 
<span class='line'> 29</span>      * @description Fix types of configuration parameters
37
 
<span class='line'> 30</span>      */</span><span class="WHIT">
38
 
<span class='line'> 31</span> </span><span class="WHIT">    </span><span class="NAME">fixTypes</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
39
 
<span class='line'> 32</span> </span><span class="WHIT">        </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">param</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">self</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">this</span><span class="PUNC">;</span><span class="WHIT">
40
 
<span class='line'> 33</span> 
41
 
<span class='line'> 34</span> </span><span class="WHIT">        </span><span class="COMM">// Booleans</span><span class="WHIT">
42
 
<span class='line'> 35</span> </span><span class="WHIT">        </span><span class="NAME">$.each</span><span class="PUNC">(</span><span class="NAME">this.bools</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
43
 
<span class='line'> 36</span> </span><span class="WHIT">            </span><span class="NAME">param</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="PUNC">.</span><span class="NAME">toLowerCase</span><span class="PUNC">(</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
44
 
<span class='line'> 37</span> </span><span class="WHIT">             
45
 
<span class='line'> 38</span>             </span><span class="KEYW">if</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">(</span><span class="NAME">param</span><span class="WHIT"> </span><span class="PUNC">===</span><span class="WHIT"> </span><span class="STRN">"true"</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">||</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">param</span><span class="WHIT"> </span><span class="PUNC">===</span><span class="WHIT"> </span><span class="STRN">"1"</span><span class="PUNC">)</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
46
 
<span class='line'> 39</span> </span><span class="WHIT">                </span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">true</span><span class="PUNC">;</span><span class="WHIT">
47
 
<span class='line'> 40</span> </span><span class="WHIT">            </span><span class="PUNC">}</span><span class="WHIT">
48
 
<span class='line'> 41</span> </span><span class="WHIT">            </span><span class="KEYW">else</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
49
 
<span class='line'> 42</span> </span><span class="WHIT">                </span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">false</span><span class="PUNC">;</span><span class="WHIT">
50
 
<span class='line'> 43</span> </span><span class="WHIT">            </span><span class="PUNC">}</span><span class="WHIT">
51
 
<span class='line'> 44</span> </span><span class="WHIT">        </span><span class="PUNC">}</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
52
 
<span class='line'> 45</span> </span><span class="WHIT">        
53
 
<span class='line'> 46</span>         </span><span class="COMM">// Integers</span><span class="WHIT">
54
 
<span class='line'> 47</span> </span><span class="WHIT">        </span><span class="NAME">$.each</span><span class="PUNC">(</span><span class="NAME">this.ints</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
55
 
<span class='line'> 48</span> </span><span class="WHIT">            </span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">parseInt</span><span class="PUNC">(</span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NUMB">10</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
56
 
<span class='line'> 49</span> </span><span class="WHIT">        </span><span class="PUNC">}</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
57
 
<span class='line'> 50</span> </span><span class="WHIT">        
58
 
<span class='line'> 51</span>         </span><span class="COMM">// Floats</span><span class="WHIT">
59
 
<span class='line'> 52</span> </span><span class="WHIT">        </span><span class="NAME">$.each</span><span class="PUNC">(</span><span class="NAME">this.floats</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
60
 
<span class='line'> 53</span> </span><span class="WHIT">            </span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">parseFloat</span><span class="PUNC">(</span><span class="NAME">self.params</span><span class="PUNC">[</span><span class="KEYW">this</span><span class="PUNC">]</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
61
 
<span class='line'> 54</span> </span><span class="WHIT">        </span><span class="PUNC">}</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
62
 
<span class='line'> 55</span> </span><span class="WHIT">    </span><span class="PUNC">}</span><span class="PUNC">,</span><span class="WHIT">
63
 
<span class='line'> 56</span> </span><span class="WHIT">    
64
 
<span class='line'> 57</span>     </span><span class="COMM">/**
65
 
<span class='line'> 58</span>      * @description Returns the configuration parameters as an associative array
66
 
<span class='line'> 59</span>      */</span><span class="WHIT">
67
 
<span class='line'> 60</span> </span><span class="WHIT">    </span><span class="NAME">toArray</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
68
 
<span class='line'> 61</span> </span><span class="WHIT">        </span><span class="KEYW">return</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
69
 
<span class='line'> 62</span> </span><span class="WHIT">            </span><span class="STRN">'version'</span><span class="WHIT">           </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"build_num"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
70
 
<span class='line'> 63</span> </span><span class="WHIT">            </span><span class="STRN">'defaultZoomLevel'</span><span class="WHIT">  </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"default_zoom_level"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
71
 
<span class='line'> 64</span> </span><span class="WHIT">            </span><span class="STRN">'defaultObsTime'</span><span class="WHIT">    </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"default_obs_time"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
72
 
<span class='line'> 65</span> </span><span class="WHIT">            </span><span class="STRN">'minZoomLevel'</span><span class="WHIT">      </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"min_zoom_level"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
73
 
<span class='line'> 66</span> </span><span class="WHIT">            </span><span class="STRN">'maxZoomLevel'</span><span class="WHIT">      </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"max_zoom_level"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
74
 
<span class='line'> 67</span> </span><span class="WHIT">            </span><span class="STRN">'baseZoom'</span><span class="WHIT">          </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"base_zoom_level"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
75
 
<span class='line'> 68</span> </span><span class="WHIT">            </span><span class="STRN">'baseScale'</span><span class="WHIT">         </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"base_image_scale"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
76
 
<span class='line'> 69</span> </span><span class="WHIT">            </span><span class="STRN">'prefetchSize'</span><span class="WHIT">      </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"prefetch_size"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
77
 
<span class='line'> 70</span> </span><span class="WHIT">            </span><span class="STRN">'timeIncrementSecs'</span><span class="WHIT"> </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"default_timestep"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
78
 
<span class='line'> 71</span> </span><span class="WHIT">            </span><span class="STRN">'tileServers'</span><span class="WHIT">       </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"tile_server"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
79
 
<span class='line'> 72</span> </span><span class="WHIT">            </span><span class="STRN">'backupServer'</span><span class="WHIT">      </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"backup_server"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
80
 
<span class='line'> 73</span> </span><span class="WHIT">            </span><span class="STRN">'backupEnabled'</span><span class="WHIT">     </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"backup_enabled"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
81
 
<span class='line'> 74</span> </span><span class="WHIT">            </span><span class="STRN">'distributed'</span><span class="WHIT">       </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"distributed_tiling_enabled"</span><span class="PUNC">]</span><span class="PUNC">,</span><span class="WHIT">
82
 
<span class='line'> 75</span> </span><span class="WHIT">            </span><span class="STRN">'rootURL'</span><span class="WHIT">           </span><span class="PUNC">:</span><span class="WHIT"> </span><span class="NAME">this.params</span><span class="PUNC">[</span><span class="STRN">"web_root_url"</span><span class="PUNC">]</span><span class="WHIT">
83
 
<span class='line'> 76</span> </span><span class="WHIT">        </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
84
 
<span class='line'> 77</span> </span><span class="WHIT">    </span><span class="PUNC">}</span><span class="WHIT">
85
 
<span class='line'> 78</span> </span><span class="PUNC">}</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
86
 
<span class='line'> 79</span> </span></pre></body></html>
 
 
b'\\ No newline at end of file'