class AsposeImagingCloud::GifProperties

Represents information about image in GIF format.

Attributes

background_color[RW]

Gets or sets the background color.

has_background_color[RW]

Gets or sets a value indicating whether background color is used.

has_trailer[RW]

Gets or sets a value indicating whether image has trailer.

pixel_aspect_ratio[RW]

Gets or sets the pixel aspect ratio.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 45
def self.attribute_map
  {
    :'background_color' => :'BackgroundColor',
    :'has_background_color' => :'HasBackgroundColor',
    :'has_trailer' => :'HasTrailer',
    :'pixel_aspect_ratio' => :'PixelAspectRatio'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 66
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?(:'BackgroundColor')
    self.background_color = attributes[:'BackgroundColor']
  end

  if attributes.has_key?(:'HasBackgroundColor')
    self.has_background_color = attributes[:'HasBackgroundColor']
  end

  if attributes.has_key?(:'HasTrailer')
    self.has_trailer = attributes[:'HasTrailer']
  end

  if attributes.has_key?(:'PixelAspectRatio')
    self.pixel_aspect_ratio = attributes[:'PixelAspectRatio']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 55
def self.swagger_types
  {
    :'background_color' => :'String',
    :'has_background_color' => :'BOOLEAN',
    :'has_trailer' => :'BOOLEAN',
    :'pixel_aspect_ratio' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 119
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      background_color == o.background_color &&
      has_background_color == o.has_background_color &&
      has_trailer == o.has_trailer &&
      pixel_aspect_ratio == o.pixel_aspect_ratio
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 166
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 = AsposeImagingCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 232
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 143
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 130
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 136
def hash
  [background_color, has_background_color, has_trailer, pixel_aspect_ratio].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 91
def list_invalid_properties
  invalid_properties = Array.new
  if @has_background_color.nil?
    invalid_properties.push('invalid value for "has_background_color", has_background_color cannot be nil.')
  end

  if @has_trailer.nil?
    invalid_properties.push('invalid value for "has_trailer", has_trailer cannot be nil.')
  end

  if @pixel_aspect_ratio.nil?
    invalid_properties.push('invalid value for "pixel_aspect_ratio", pixel_aspect_ratio cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 212
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 218
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 206
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose-imaging-cloud/models/gif_properties.rb, line 110
def valid?
  return false if @has_background_color.nil?
  return false if @has_trailer.nil?
  return false if @pixel_aspect_ratio.nil?
  true
end