Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / MCollective / Aggregate.html
diff --git a/doc/MCollective/Aggregate.html b/doc/MCollective/Aggregate.html
new file mode 100644 (file)
index 0000000..7afc5c4
--- /dev/null
@@ -0,0 +1,732 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+       <title>Class: MCollective::Aggregate</title>
+
+       <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+       <script src="../js/jquery.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../js/thickbox-compressed.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../js/quicksearch.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="../js/darkfish.js" type="text/javascript"
+               charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+       <div id="metadata">
+               <div id="file-metadata">
+                       <div id="file-list-section" class="section">
+                               <h3 class="section-header">In Files</h3>
+                               <div class="section-body">
+                                       <ul>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate.rb">lib/mcollective/aggregate.rb</a></li>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.rb</a></li>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate/result/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.rb</a></li>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate/result/numeric_result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.rb</a></li>
+                                       
+                                               <li><a href="../lib/mcollective/aggregate/result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+                                                       class="thickbox" title="lib/mcollective/aggregate/result.rb">lib/mcollective/aggregate/result.rb</a></li>
+                                       
+                                       </ul>
+                               </div>
+                       </div>
+
+                       
+               </div>
+
+               <div id="class-metadata">
+
+                       <!-- Parent Class -->
+                       
+                       <div id="parent-class-section" class="section">
+                               <h3 class="section-header">Parent</h3>
+                               
+                               <p class="link"><a href="../Object.html">Object</a></p>
+                               
+                       </div>
+                       
+
+                       <!-- Namespace Contents -->
+                       
+                       <div id="namespace-list-section" class="section">
+                               <h3 class="section-header">Namespace</h3>
+                               <ul class="link-list">
+                                       
+                                       <li><span class="type">MODULE</span> <a href="Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+                                       
+                                       <li><span class="type">CLASS</span> <a href="Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+                                       
+                               </ul>
+                       </div>
+                       
+
+                       <!-- Method Quickref -->
+                       
+                       <div id="method-list-section" class="section">
+                               <h3 class="section-header">Methods</h3>
+                               <ul class="link-list">
+                                       
+                                       <li><a href="#M000135">::new</a></li>
+                                       
+                                       <li><a href="#M000138">#call_functions</a></li>
+                                       
+                                       <li><a href="#M000137">#contains_output?</a></li>
+                                       
+                                       <li><a href="#M000136">#create_functions</a></li>
+                                       
+                                       <li><a href="#M000140">#load_function</a></li>
+                                       
+                                       <li><a href="#M000139">#summarize</a></li>
+                                       
+                               </ul>
+                       </div>
+                       
+
+                       <!-- Included Modules -->
+                       
+               </div>
+
+               <div id="project-metadata">
+                       
+                       
+                       <div id="fileindex-section" class="section project-section">
+                               <h3 class="section-header">Files</h3>
+                               <ul>
+                               
+                                       <li class="file"><a href="../COPYING.html">COPYING</a></li>
+                               
+                                       <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
+                               
+                                       <li class="file"><a href="../README.html">README</a></li>
+                               
+                                       <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
+                               
+                                       <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+                               
+                                       <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+                               
+                                       <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+                               
+                                       <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+                               
+                                       <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+                               
+                                       <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
+                               
+                               </ul>
+                       </div>
+                       
+
+                       <div id="classindex-section" class="section project-section">
+                               <h3 class="section-header">Class Index
+                                       <span class="search-toggle"><img src="../images/find.png"
+                                               height="16" width="16" alt="[+]"
+                                               title="show/hide quicksearch" /></span></h3>
+                               <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+                               <fieldset>
+                                       <legend>Quicksearch</legend>
+                                       <input type="text" name="quicksearch" value=""
+                                               class="quicksearch-field" />
+                               </fieldset>
+                               </form>
+
+                               <ul class="link-list">
+                               
+                                       <li><a href="../MCollective.html">MCollective</a></li>
+                               
+                                       <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
+                               
+                                       <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+                               
+                                       <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+                               
+                                       <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
+                               
+                                       <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
+                               
+                                       <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
+                               
+                                       <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
+                               
+                                       <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
+                               
+                                       <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
+                               
+                                       <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
+                               
+                                       <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+                               
+                                       <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
+                               
+                                       <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+                               
+                                       <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+                               
+                                       <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+                               
+                                       <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+                               
+                                       <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+                               
+                                       <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+                               
+                                       <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
+                               
+                                       <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+                               
+                                       <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
+                               
+                                       <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
+                               
+                                       <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
+                               
+                                       <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+                               
+                                       <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+                               
+                                       <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+                               
+                                       <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
+                               
+                                       <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
+                               
+                                       <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+                               
+                                       <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+                               
+                                       <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+                               
+                                       <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
+                               
+                                       <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+                               
+                                       <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+                               
+                                       <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
+                               
+                                       <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+                               
+                                       <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+                               
+                                       <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+                               
+                                       <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+                               
+                                       <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+                               
+                                       <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+                               
+                                       <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+                               
+                                       <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+                               
+                                       <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+                               
+                                       <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+                               
+                                       <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+                               
+                                       <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+                               
+                                       <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
+                               
+                                       <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
+                               
+                                       <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+                               
+                                       <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
+                               
+                                       <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+                               
+                                       <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
+                               
+                                       <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
+                               
+                                       <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+                               
+                                       <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+                               
+                                       <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
+                               
+                                       <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
+                               
+                                       <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+                               
+                                       <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+                               
+                                       <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+                               
+                                       <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
+                               
+                                       <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
+                               
+                                       <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+                               
+                                       <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+                               
+                                       <li><a href="../Array.html">Array</a></li>
+                               
+                                       <li><a href="../Dir.html">Dir</a></li>
+                               
+                                       <li><a href="../Object.html">Object</a></li>
+                               
+                                       <li><a href="../String.html">String</a></li>
+                               
+                                       <li><a href="../Symbol.html">Symbol</a></li>
+                               
+                               </ul>
+                               <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+                       </div>
+
+                       
+               </div>
+       </div>
+
+       <div id="documentation">
+               <h1 class="class">MCollective::Aggregate</h1>
+
+               <div id="description">
+                       
+               </div>
+
+               <!-- Constants -->
+               
+
+               <!-- Attributes -->
+               
+               <div id="attribute-method-details" class="method-section section">
+                       <h3 class="section-header">Attributes</h3>
+
+                       
+                       <div id="ddl-attribute-method" class="method-detail">
+                               <a name="ddl"></a>
+                               
+                               <a name="ddl="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">ddl</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="functions-attribute-method" class="method-detail">
+                               <a name="functions"></a>
+                               
+                               <a name="functions="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">functions</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="action-attribute-method" class="method-detail">
+                               <a name="action"></a>
+                               
+                               <a name="action="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">action</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+                       <div id="failed-attribute-method" class="method-detail">
+                               <a name="failed"></a>
+                               
+                               <a name="failed="></a>
+                               
+                               <div class="method-heading attribute-method-heading">
+                                       <span class="method-name">failed</span><span
+                                               class="attribute-access-type">[RW]</span>
+                               </div>
+
+                               <div class="method-description">
+                               
+                               <p class="missing-docs">(Not documented)</p>
+                               
+                               </div>
+                       </div>
+                       
+               </div>
+               
+
+               <!-- Methods -->
+               
+               <div id="public-class-method-details" class="method-section section">
+                       <h3 class="section-header">Public Class Methods</h3>
+
+               
+                       <div id="new-method" class="method-detail ">
+                               <a name="M000135"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">new</span><span
+                                               class="method-args">(ddl)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p class="missing-docs">(Not documented)</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="new-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 8</span>
+ 8:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">ddl</span>)
+ 9:       <span class="ruby-ivar">@functions</span> = []
+10:       <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
+11:       <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">ddl</span>[<span class="ruby-identifier">:action</span>]
+12:       <span class="ruby-ivar">@failed</span> = []
+13: 
+14:       <span class="ruby-identifier">create_functions</span>
+15:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+               <div id="public-instance-method-details" class="method-section section">
+                       <h3 class="section-header">Public Instance Methods</h3>
+
+               
+                       <div id="call-functions-method" class="method-detail ">
+                               <a name="M000138"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">call_functions</span><span
+                                               class="method-args">(reply)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Call all the appropriate functions with the reply data received from <a
+href="RPC/Client.html">RPC::Client</a>
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="call-functions-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 45</span>
+45:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_functions</span>(<span class="ruby-identifier">reply</span>)
+46:       <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
+47:         <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Calling aggregate function #{function} for result&quot;</span>)
+48:         <span class="ruby-keyword kw">begin</span>
+49:           <span class="ruby-identifier">function</span>.<span class="ruby-identifier">process_result</span>(<span class="ruby-identifier">reply</span>[<span class="ruby-identifier">:data</span>][<span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>], <span class="ruby-identifier">reply</span>)
+50:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+51:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Could not process aggregate function for '#{function.output_name}'. #{e.to_s}&quot;</span>)
+52:           <span class="ruby-ivar">@failed</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:process_result</span>}
+53:           <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">function</span>)
+54:         <span class="ruby-keyword kw">end</span>
+55:       <span class="ruby-keyword kw">end</span>
+56:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="contains-output--method" class="method-detail ">
+                               <a name="M000137"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">contains_output?</span><span
+                                               class="method-args">(output)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Check if the function param is defined as an output for the action in the
+ddl
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="contains-output--source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 40</span>
+40:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
+41:       <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output</span>)
+42:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="create-functions-method" class="method-detail ">
+                               <a name="M000136"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">create_functions</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Creates instances of the <a href="Aggregate.html">Aggregate</a> functions
+and stores them in the function array. All aggregate call and summarize
+method calls operate on these function as a batch.
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="create-functions-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 19</span>
+19:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_functions</span>
+20:       <span class="ruby-ivar">@ddl</span>[<span class="ruby-identifier">:aggregate</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">agg</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+21:         <span class="ruby-identifier">output</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">0</span>]
+22: 
+23:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">contains_output?</span>(<span class="ruby-identifier">output</span>)
+24:           <span class="ruby-identifier">arguments</span> = <span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">1</span>]
+25:           <span class="ruby-identifier">format</span> = (<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:format</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arguments</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>
+26:           <span class="ruby-keyword kw">begin</span>
+27:             <span class="ruby-ivar">@functions</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">agg</span>[<span class="ruby-identifier">:function</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-identifier">output</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">format</span>, <span class="ruby-ivar">@action</span>)
+28:           <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+29:             <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Cannot create aggregate function '#{output}'. #{e.to_s}&quot;</span>)
+30:             <span class="ruby-ivar">@failed</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:startup</span>}
+31:           <span class="ruby-keyword kw">end</span>
+32:         <span class="ruby-keyword kw">else</span>
+33:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Cannot create aggregate function '#{output}'. '#{output}' has not been specified as a valid ddl output.&quot;</span>)
+34:           <span class="ruby-ivar">@failed</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">output</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:create</span>}
+35:         <span class="ruby-keyword kw">end</span>
+36:       <span class="ruby-keyword kw">end</span>
+37:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="load-function-method" class="method-detail ">
+                               <a name="M000140"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">load_function</span><span
+                                               class="method-args">(function_name)</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Loads function from disk for use
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="load-function-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 76</span>
+76:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_function</span>(<span class="ruby-identifier">function_name</span>)
+77:       <span class="ruby-identifier">function_name</span> = <span class="ruby-identifier">function_name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>
+78: 
+79:       <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-node">&quot;MCollective::Aggregate::#{function_name}&quot;</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">function_name</span>)
+80:       <span class="ruby-constant">Aggregate</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">function_name</span>)
+81:     <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
+82:       <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Aggregate function file '#{function_name.downcase}.rb' cannot be loaded&quot;</span>
+83:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+                       <div id="summarize-method" class="method-detail ">
+                               <a name="M000139"></a>
+
+                               <div class="method-heading">
+                               
+                                       <span class="method-name">summarize</span><span
+                                               class="method-args">()</span>
+                                       <span class="method-click-advice">click to toggle source</span>
+                               
+                               </div>
+
+                               <div class="method-description">
+                                       
+                                       <p>
+Finalizes the function returning a result object
+</p>
+                                       
+
+                                       
+                                       <div class="method-source-code"
+                                               id="summarize-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/mcollective/aggregate.rb, line 59</span>
+59:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
+60:       <span class="ruby-identifier">summary</span> = <span class="ruby-ivar">@functions</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">function</span><span class="ruby-operator">|</span>
+61:         <span class="ruby-keyword kw">begin</span>
+62:           <span class="ruby-identifier">function</span>.<span class="ruby-identifier">summarize</span>
+63:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+64:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Could not summarize aggregate result for '#{function.output_name}'. #{e.to_s}&quot;</span>)
+65:           <span class="ruby-ivar">@failed</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">function</span>.<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:summarize</span>}
+66:           <span class="ruby-keyword kw">nil</span>
+67:         <span class="ruby-keyword kw">end</span>
+68:       <span class="ruby-keyword kw">end</span>
+69: 
+70:       <span class="ruby-identifier">summary</span>.<span class="ruby-identifier">reject</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">nil?</span>}.<span class="ruby-identifier">sort</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span>
+71:         <span class="ruby-identifier">x</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>] <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">y</span>.<span class="ruby-identifier">result</span>[<span class="ruby-identifier">:output</span>]
+72:       <span class="ruby-keyword kw">end</span>
+73:     <span class="ruby-keyword kw">end</span></pre>
+                                       </div>
+                                       
+                               </div>
+
+                               
+                       </div>
+
+               
+               </div>
+       
+
+       </div>
+
+
+       <div id="rdoc-debugging-section-dump" class="debugging-section">
+       
+               <p>Disabled; run with --debug to generate this.</p>
+       
+       </div>
+
+       <div id="validator-badges">
+               <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+               <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+                       Rdoc Generator</a> 1.1.6</small>.</p>
+       </div>
+
+</body>
+</html>
+