X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2FMCollective%2FAggregate%2FBase.html;fp=doc%2FMCollective%2FAggregate%2FBase.html;h=e8b1de19171f71fcdae7181bd8c72ff0096ae0b0;hb=7c9314f502cde8daad23b61d10b24a542e04154a;hp=0000000000000000000000000000000000000000;hpb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/MCollective/Aggregate/Base.html b/doc/MCollective/Aggregate/Base.html new file mode 100644 index 0000000..e8b1de1 --- /dev/null +++ b/doc/MCollective/Aggregate/Base.html @@ -0,0 +1,593 @@ + + + + + + + Class: MCollective::Aggregate::Base + + + + + + + + + + + +
+
+
+

In Files

+
+ +
+
+ + +
+ +
+ + + +
+

Parent

+ +

Object

+ +
+ + + + + + + +
+

Methods

+ +
+ + + + +
+ +
+ + + + + +
+

Class Index + [+]

+
+
+ Quicksearch + +
+
+ + + +
+ + +
+
+ +
+

MCollective::Aggregate::Base

+ +
+ +
+ + + + + + +
+

Attributes

+ + +
+ + + + +
+ name[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+ result[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+ output_name[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+ action[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+ aggregate_format[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+ arguments[RW] +
+ +
+ +

(Not documented)

+ +
+
+ +
+ + + + +
+

Public Class Methods

+ + +
+ + +
+ + new(output_name, arguments, aggregate_format, action) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/aggregate/base.rb, line 6
+ 6:       def initialize(output_name, arguments, aggregate_format, action)
+ 7:         @name = self.class.to_s
+ 8:         @output_name = output_name
+ 9: 
+10:         # Any additional arguments passed in the ddl after the output field will
+11:         # be stored in the arguments array which can be used in the function
+12:         @arguments = arguments
+13:         @aggregate_format = aggregate_format
+14:         @action = action
+15:         @result = {:value => nil, :type => nil, :output => output_name}
+16: 
+17:         startup_hook
+18:       end
+
+ +
+ + +
+ + +
+ +
+

Public Instance Methods

+ + +
+ + +
+ + result_class(type) + click to toggle source + +
+ +
+ +

(Not documented)

+ + + +
+
+    # File lib/mcollective/aggregate/base.rb, line 35
+35:       def result_class(type)
+36:         Result.const_get("#{type.to_s.capitalize}Result")
+37:       end
+
+ +
+ + +
+ + +
+ + +
+ + summarize() + click to toggle source + +
+ +
+ +

+Stops execution of the function and returns a specific ResultObject, +aggregate functions will most likely override this but this is the simplest +case so we might as well default to that +

+ + + +
+
+    # File lib/mcollective/aggregate/base.rb, line 29
+29:       def summarize
+30:         raise "Result type is not set while trying to summarize aggregate function results" unless @result[:type]
+31: 
+32:         result_class(@result[:type]).new(@result, @aggregate_format, @action)
+33:       end
+
+ +
+ + +
+ + +
+ + +
+ + +
+ +

Disabled; run with --debug to generate this.

+ +
+ +
+

[Validate]

+

Generated with the Darkfish + Rdoc Generator 1.1.6.

+
+ + + +