1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Class: MCollective::Aggregate::Base</title>
10 <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
12 <script src="../../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../../lib/mcollective/aggregate/base_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.rb</a></li>
41 <div id="class-metadata">
45 <div id="parent-class-section" class="section">
46 <h3 class="section-header">Parent</h3>
48 <p class="link"><a href="../../Object.html">Object</a></p>
53 <!-- Namespace Contents -->
56 <!-- Method Quickref -->
58 <div id="method-list-section" class="section">
59 <h3 class="section-header">Methods</h3>
60 <ul class="link-list">
62 <li><a href="#M000249">::new</a></li>
64 <li><a href="#M000251">#result_class</a></li>
66 <li><a href="#M000250">#summarize</a></li>
72 <!-- Included Modules -->
76 <div id="project-metadata">
79 <div id="fileindex-section" class="section project-section">
80 <h3 class="section-header">Files</h3>
83 <li class="file"><a href="../../COPYING.html">COPYING</a></li>
85 <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
87 <li class="file"><a href="../../README.html">README</a></li>
89 <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
91 <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
93 <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
95 <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
97 <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
99 <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
101 <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
103 <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
105 <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
107 <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
109 <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
111 <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
113 <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
115 <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
117 <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
119 <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
121 <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
127 <div id="classindex-section" class="section project-section">
128 <h3 class="section-header">Class Index
129 <span class="search-toggle"><img src="../../images/find.png"
130 height="16" width="16" alt="[+]"
131 title="show/hide quicksearch" /></span></h3>
132 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
134 <legend>Quicksearch</legend>
135 <input type="text" name="quicksearch" value=""
136 class="quicksearch-field" />
140 <ul class="link-list">
142 <li><a href="../../MCollective.html">MCollective</a></li>
144 <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
146 <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
148 <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
150 <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
152 <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
154 <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
156 <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
158 <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
160 <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
162 <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
164 <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
166 <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
168 <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
170 <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
172 <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
174 <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
176 <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
178 <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
180 <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
182 <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
184 <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
186 <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
188 <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
190 <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
192 <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
194 <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
196 <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
198 <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
200 <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
202 <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
204 <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
206 <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
208 <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
210 <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
212 <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
214 <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
216 <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
218 <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
220 <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
222 <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
224 <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
226 <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
228 <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
230 <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
232 <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
234 <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
236 <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
238 <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
240 <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
242 <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
244 <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
246 <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
248 <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
250 <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
252 <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
254 <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
256 <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
258 <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
260 <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
262 <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
264 <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
266 <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
268 <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
270 <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
272 <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
274 <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
276 <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
278 <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
280 <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
282 <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
284 <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
286 <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
288 <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
290 <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
292 <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
294 <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
296 <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
298 <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
300 <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
302 <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
304 <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
306 <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
308 <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
310 <li><a href="../../Array.html">Array</a></li>
312 <li><a href="../../Dir.html">Dir</a></li>
314 <li><a href="../../Object.html">Object</a></li>
316 <li><a href="../../String.html">String</a></li>
318 <li><a href="../../Symbol.html">Symbol</a></li>
321 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
328 <div id="documentation">
329 <h1 class="class">MCollective::Aggregate::Base</h1>
331 <div id="description">
340 <div id="attribute-method-details" class="method-section section">
341 <h3 class="section-header">Attributes</h3>
344 <div id="name-attribute-method" class="method-detail">
349 <div class="method-heading attribute-method-heading">
350 <span class="method-name">name</span><span
351 class="attribute-access-type">[RW]</span>
354 <div class="method-description">
356 <p class="missing-docs">(Not documented)</p>
361 <div id="result-attribute-method" class="method-detail">
362 <a name="result"></a>
364 <a name="result="></a>
366 <div class="method-heading attribute-method-heading">
367 <span class="method-name">result</span><span
368 class="attribute-access-type">[RW]</span>
371 <div class="method-description">
373 <p class="missing-docs">(Not documented)</p>
378 <div id="output-name-attribute-method" class="method-detail">
379 <a name="output_name"></a>
381 <a name="output_name="></a>
383 <div class="method-heading attribute-method-heading">
384 <span class="method-name">output_name</span><span
385 class="attribute-access-type">[RW]</span>
388 <div class="method-description">
390 <p class="missing-docs">(Not documented)</p>
395 <div id="action-attribute-method" class="method-detail">
396 <a name="action"></a>
398 <a name="action="></a>
400 <div class="method-heading attribute-method-heading">
401 <span class="method-name">action</span><span
402 class="attribute-access-type">[RW]</span>
405 <div class="method-description">
407 <p class="missing-docs">(Not documented)</p>
412 <div id="aggregate-format-attribute-method" class="method-detail">
413 <a name="aggregate_format"></a>
415 <a name="aggregate_format="></a>
417 <div class="method-heading attribute-method-heading">
418 <span class="method-name">aggregate_format</span><span
419 class="attribute-access-type">[RW]</span>
422 <div class="method-description">
424 <p class="missing-docs">(Not documented)</p>
429 <div id="arguments-attribute-method" class="method-detail">
430 <a name="arguments"></a>
432 <a name="arguments="></a>
434 <div class="method-heading attribute-method-heading">
435 <span class="method-name">arguments</span><span
436 class="attribute-access-type">[RW]</span>
439 <div class="method-description">
441 <p class="missing-docs">(Not documented)</p>
451 <div id="public-class-method-details" class="method-section section">
452 <h3 class="section-header">Public Class Methods</h3>
455 <div id="new-method" class="method-detail ">
456 <a name="M000249"></a>
458 <div class="method-heading">
460 <span class="method-name">new</span><span
461 class="method-args">(output_name, arguments, aggregate_format, action)</span>
462 <span class="method-click-advice">click to toggle source</span>
466 <div class="method-description">
468 <p class="missing-docs">(Not documented)</p>
472 <div class="method-source-code"
475 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 6</span>
476 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
477 7: <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
478 8: <span class="ruby-ivar">@output_name</span> = <span class="ruby-identifier">output_name</span>
480 10: <span class="ruby-comment cmt"># Any additional arguments passed in the ddl after the output field will</span>
481 11: <span class="ruby-comment cmt"># be stored in the arguments array which can be used in the function</span>
482 12: <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>
483 13: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
484 14: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
485 15: <span class="ruby-ivar">@result</span> = {<span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">output_name</span>}
487 17: <span class="ruby-identifier">startup_hook</span>
488 18: <span class="ruby-keyword kw">end</span></pre>
499 <div id="public-instance-method-details" class="method-section section">
500 <h3 class="section-header">Public Instance Methods</h3>
503 <div id="result-class-method" class="method-detail ">
504 <a name="M000251"></a>
506 <div class="method-heading">
508 <span class="method-name">result_class</span><span
509 class="method-args">(type)</span>
510 <span class="method-click-advice">click to toggle source</span>
514 <div class="method-description">
516 <p class="missing-docs">(Not documented)</p>
520 <div class="method-source-code"
521 id="result-class-source">
523 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 35</span>
524 35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_class</span>(<span class="ruby-identifier">type</span>)
525 36: <span class="ruby-constant">Result</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{type.to_s.capitalize}Result"</span>)
526 37: <span class="ruby-keyword kw">end</span></pre>
535 <div id="summarize-method" class="method-detail ">
536 <a name="M000250"></a>
538 <div class="method-heading">
540 <span class="method-name">summarize</span><span
541 class="method-args">()</span>
542 <span class="method-click-advice">click to toggle source</span>
546 <div class="method-description">
549 Stops execution of the function and returns a specific ResultObject,
550 aggregate functions will most likely override this but this is the simplest
551 case so we might as well default to that
556 <div class="method-source-code"
557 id="summarize-source">
559 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 29</span>
560 29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
561 30: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Result type is not set while trying to summarize aggregate function results"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
563 32: <span class="ruby-identifier">result_class</span>(<span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@result</span>, <span class="ruby-ivar">@aggregate_format</span>, <span class="ruby-ivar">@action</span>)
564 33: <span class="ruby-keyword kw">end</span></pre>
579 <div id="rdoc-debugging-section-dump" class="debugging-section">
581 <p>Disabled; run with --debug to generate this.</p>
585 <div id="validator-badges">
586 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
587 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
588 Rdoc Generator</a> 1.1.6</small>.</p>