Update version according to OSCI-856
[packages/precise/mcollective.git] / doc / classes / MCollective / Aggregate / Result / NumericResult.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html 
3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8   <title>Class: MCollective::Aggregate::Result::NumericResult</title>
9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
11   <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12   <script type="text/javascript">
13   // <![CDATA[
14
15   function popupCode( url ) {
16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17   }
18
19   function toggleCode( id ) {
20     if ( document.getElementById )
21       elem = document.getElementById( id );
22     else if ( document.all )
23       elem = eval( "document.all." + id );
24     else
25       return false;
26
27     elemStyle = elem.style;
28     
29     if ( elemStyle.display != "block" ) {
30       elemStyle.display = "block"
31     } else {
32       elemStyle.display = "none"
33     }
34
35     return true;
36   }
37   
38   // Make codeblocks hidden by default
39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40   
41   // ]]>
42   </script>
43
44 </head>
45 <body>
46
47
48
49     <div id="classHeader">
50         <table class="header-table">
51         <tr class="top-aligned-row">
52           <td><strong>Class</strong></td>
53           <td class="class-name-in-header">MCollective::Aggregate::Result::NumericResult</td>
54         </tr>
55         <tr class="top-aligned-row">
56             <td><strong>In:</strong></td>
57             <td>
58                 <a href="../../../../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
59                 lib/mcollective/aggregate/result/numeric_result.rb
60                 </a>
61         <br />
62             </td>
63         </tr>
64
65         <tr class="top-aligned-row">
66             <td><strong>Parent:</strong></td>
67             <td>
68                 <a href="Base.html">
69                 Base
70                </a>
71             </td>
72         </tr>
73         </table>
74     </div>
75   <!-- banner header -->
76
77   <div id="bodyContent">
78
79
80
81   <div id="contextContent">
82
83
84
85    </div>
86
87     <div id="method-list">
88       <h3 class="section-bar">Methods</h3>
89
90       <div class="name-list">
91       <a href="#M000419">to_s</a>&nbsp;&nbsp;
92       </div>
93     </div>
94
95   </div>
96
97
98     <!-- if includes -->
99
100     <div id="section">
101
102
103
104
105
106       
107
108
109     <!-- if method_list -->
110     <div id="methods">
111       <h3 class="section-bar">Public Instance methods</h3>
112
113       <div id="method-M000419" class="method-detail">
114         <a name="M000419"></a>
115
116         <div class="method-heading">
117           <a href="#M000419" class="method-signature">
118           <span class="method-name">to_s</span><span class="method-args">()</span>
119           </a>
120         </div>
121       
122         <div class="method-description">
123           <p><a class="source-toggle" href="#"
124             onclick="toggleCode('M000419-source');return false;">[Source]</a></p>
125           <div class="method-source-code" id="M000419-source">
126 <pre>
127    <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/numeric_result.rb, line 5</span>
128 5:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
129 6:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">nil?</span>
130 7: 
131 8:           <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>]
132 9:         <span class="ruby-keyword kw">end</span>
133 </pre>
134           </div>
135         </div>
136       </div>
137
138
139     </div>
140
141
142   </div>
143
144
145 <div id="validator-badges">
146   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
147 </div>
148
149 </body>
150 </html>