Class: AsposeCellsCloud::AboveAverage

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/above_average.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AboveAverage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 61

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'IsAboveAverage')
      self.is_above_average = attributes[:'IsAboveAverage']
  end
  if attributes.has_key?(:'IsEqualAverage')
      self.is_equal_average = attributes[:'IsEqualAverage']
  end
  if attributes.has_key?(:'StdDev')
      self.std_dev = attributes[:'StdDev']
  end

end

Instance Attribute Details

#is_above_average ⇒ Object

Get or set the flag indicating whether the rule is an “above average” rule. ‘true’ indicates ‘above average’. Default value is true.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 35

def is_above_average
  @is_above_average
end

#is_equal_average ⇒ Object

Get or set the flag indicating whether the ‘aboveAverage’ and ‘belowAverage’ criteria is inclusive of the average itself, or exclusive of that value. ‘true’ indicates to include the average value in the criteria. Default value is false.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 37

def is_equal_average
  @is_equal_average
end

#std_dev ⇒ Object

Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 39

def std_dev
  @std_dev
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



42
43
44
45
46
47
48
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 42

def self.attribute_map
  {
    :'is_above_average' => :'IsAboveAverage',
    :'is_equal_average' => :'IsEqualAverage',
    :'std_dev' => :'StdDev'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 51

def self.swagger_types
  {
    :'is_above_average' => :'BOOLEAN',
    :'is_equal_average' => :'BOOLEAN',
    :'std_dev' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_above_average == o.is_above_average &&
      is_equal_average == o.is_equal_average &&
      std_dev == o.std_dev 
      std_dev == o.std_dev
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 152

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 218

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 131

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 118

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 124

def hash
  [ is_above_average , is_equal_average , std_dev ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 81

def list_invalid_properties
  invalid_properties = Array.new
  if @is_above_average.nil?
      invalid_properties.push("invalid value for 'is_above_average', is_above_average cannot be nil.")
  end
  if @is_equal_average.nil?
      invalid_properties.push("invalid value for 'is_equal_average', is_equal_average cannot be nil.")
  end
  if @std_dev.nil?
      invalid_properties.push("invalid value for 'std_dev', std_dev cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



198
199
200
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 198

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 204

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



192
193
194
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 192

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



98
99
100
101
102
103
 
# File 'lib/aspose_cells_cloud/models/above_average.rb', line 98

def valid?
  return false if @is_above_average.nil?
  return false if @is_equal_average.nil?
  return false if @std_dev.nil?
  return true
end