doc/classes/MCollective/Aggregate/Result/Base.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::Base</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::Base</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/base_rb.html">
  59                 lib/mcollective/aggregate/result/base.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                 Object
  69             </td>
  70         </tr>
  71         </table>
  72     </div>
  73   <!-- banner header -->
  74
  75   <div id="bodyContent">
  76
  77
  78
  79   <div id="contextContent">
  80
  81
  82
  83    </div>
  84
  85     <div id="method-list">
  86       <h3 class="section-bar">Methods</h3>
  87
  88       <div class="name-list">
  89       <a href="#M000416">new</a>&nbsp;&nbsp;
  90       <a href="#M000418">result_type</a>&nbsp;&nbsp;
  91       <a href="#M000417">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     <div id="attribute-list">
 107       <h3 class="section-bar">Attributes</h3>
 108
 109       <div class="name-list">
 110         <table>
 111         <tr class="top-aligned-row context-row">
 112           <td class="context-item-name">action</td>
 113           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 114           <td class="context-item-desc"></td>
 115         </tr>
 116         <tr class="top-aligned-row context-row">
 117           <td class="context-item-name">aggregate_format</td>
 118           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 119           <td class="context-item-desc"></td>
 120         </tr>
 121         <tr class="top-aligned-row context-row">
 122           <td class="context-item-name">result</td>
 123           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 124           <td class="context-item-desc"></td>
 125         </tr>
 126         </table>
 127       </div>
 128     </div>
 129
 130
 131
 132     <!-- if method_list -->
 133     <div id="methods">
 134       <h3 class="section-bar">Public Class methods</h3>
 135
 136       <div id="method-M000416" class="method-detail">
 137         <a name="M000416"></a>
 138
 139         <div class="method-heading">
 140           <a href="#M000416" class="method-signature">
 141           <span class="method-name">new</span><span class="method-args">(result, aggregate_format, action)</span>
 142           </a>
 143         </div>
 144
 145         <div class="method-description">
 146           <p><a class="source-toggle" href="#"
 147             onclick="toggleCode('M000416-source');return false;">[Source]</a></p>
 148           <div class="method-source-code" id="M000416-source">
 149 <pre>
 150     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 7</span>
 151  7:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
 152  8:           <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;No aggregate_format defined in ddl or aggregate function&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">aggregate_format</span>
 153  9:
 154 10:           <span class="ruby-ivar">@result</span> = <span class="ruby-identifier">result</span>
 155 11:           <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
 156 12:           <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
 157 13:         <span class="ruby-keyword kw">end</span>
 158 </pre>
 159           </div>
 160         </div>
 161       </div>
 162
 163       <h3 class="section-bar">Public Instance methods</h3>
 164
 165       <div id="method-M000418" class="method-detail">
 166         <a name="M000418"></a>
 167
 168         <div class="method-heading">
 169           <a href="#M000418" class="method-signature">
 170           <span class="method-name">result_type</span><span class="method-args">()</span>
 171           </a>
 172         </div>
 173
 174         <div class="method-description">
 175           <p><a class="source-toggle" href="#"
 176             onclick="toggleCode('M000418-source');return false;">[Source]</a></p>
 177           <div class="method-source-code" id="M000418-source">
 178 <pre>
 179     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 19</span>
 180 19:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_type</span>
 181 20:           <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
 182 21:         <span class="ruby-keyword kw">end</span>
 183 </pre>
 184           </div>
 185         </div>
 186       </div>
 187
 188       <div id="method-M000417" class="method-detail">
 189         <a name="M000417"></a>
 190
 191         <div class="method-heading">
 192           <a href="#M000417" class="method-signature">
 193           <span class="method-name">to_s</span><span class="method-args">()</span>
 194           </a>
 195         </div>
 196
 197         <div class="method-description">
 198           <p><a class="source-toggle" href="#"
 199             onclick="toggleCode('M000417-source');return false;">[Source]</a></p>
 200           <div class="method-source-code" id="M000417-source">
 201 <pre>
 202     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 15</span>
 203 15:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 204 16:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;'to_s' method not implemented for result class '#{self.class}'&quot;</span>
 205 17:         <span class="ruby-keyword kw">end</span>
 206 </pre>
 207           </div>
 208         </div>
 209       </div>
 210
 211
 212     </div>
 213
 214
 215   </div>
 216
 217
 218 <div id="validator-badges">
 219   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 220 </div>
 221
 222 </body>
 223 </html>