Class: AsposePdfCloud::Image

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/image.rb

Overview

Represents image DTO.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Image

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 73

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?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.has_key?(:'Rectangle')
    self.rectangle = attributes[:'Rectangle']
  end

  if attributes.has_key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end

end

Instance Attribute Details

#height ⇒ Object

Gets height of the image.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 35

def height
  @height
end

#id ⇒ Object

Gets ID of the image.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 38

def id
  @id
end

#links ⇒ Object

Link to the document.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 29

def links
  @links
end

#page_number ⇒ Object

Gets page number.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 44

def page_number
  @page_number
end

#rectangle ⇒ Object

Gets rectangle of the image.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 41

def rectangle
  @rectangle
end

#width ⇒ Object

Gets width of the image.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 32

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 48

def self.attribute_map
  {
    :'links' => :'Links',
    :'width' => :'Width',
    :'height' => :'Height',
    :'id' => :'Id',
    :'rectangle' => :'Rectangle',
    :'page_number' => :'PageNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 60

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'id' => :'String',
    :'rectangle' => :'Rectangle',
    :'page_number' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      width == o.width &&
      height == o.height &&
      id == o.id &&
      rectangle == o.rectangle &&
      page_number == o.page_number
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 184

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 = AsposePdfCloud.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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 250

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 163

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


150
151
152
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 156

def hash
  [links, width, height, id, rectangle, page_number].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 109

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

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

  if @page_number.nil?
    invalid_properties.push("invalid value for 'page_number', page_number 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



230
231
232
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 230

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



236
237
238
239
240
241
242
243
244
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 236

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



224
225
226
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 224

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



128
129
130
131
132
133
 
# File 'lib/aspose_pdf_cloud/models/image.rb', line 128

def valid?
  return false if @width.nil?
  return false if @height.nil?
  return false if @page_number.nil?
  return true
end