Class: TestKaferiCloud::TiffExportOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/test_kaferi_cloud/models/tiff_export_options.rb

Overview

Used for tiff export options setting.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TiffExportOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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
189
190
191
192
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 122

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?(:'Brightness')
    self.brightness = attributes[:'Brightness']
  end

  if attributes.has_key?(:'Compression')
    self.compression = attributes[:'Compression']
  end

  if attributes.has_key?(:'ColorDepth')
    self.color_depth = attributes[:'ColorDepth']
  end

  if attributes.has_key?(:'LeftMargin')
    self.left_margin = attributes[:'LeftMargin']
  end

  if attributes.has_key?(:'RightMargin')
    self.right_margin = attributes[:'RightMargin']
  end

  if attributes.has_key?(:'TopMargin')
    self.top_margin = attributes[:'TopMargin']
  end

  if attributes.has_key?(:'BottomMargin')
    self.bottom_margin = attributes[:'BottomMargin']
  end

  if attributes.has_key?(:'Orientation')
    self.orientation = attributes[:'Orientation']
  end

  if attributes.has_key?(:'SkipBlankPages')
    self.skip_blank_pages = attributes[:'SkipBlankPages']
  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?(:'XResolution')
    self.x_resolution = attributes[:'XResolution']
  end

  if attributes.has_key?(:'YResolution')
    self.y_resolution = attributes[:'YResolution']
  end

  if attributes.has_key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.has_key?(:'PageCount')
    self.page_count = attributes[:'PageCount']
  end

  if attributes.has_key?(:'ResultFile')
    self.result_file = attributes[:'ResultFile']
  end

end

Instance Attribute Details

#bottom_margin ⇒ Object

Bottom image margin.



46
47
48
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 46

def bottom_margin
  @bottom_margin
end

#brightness ⇒ Object

Image brightness.



28
29
30
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 28

def brightness
  @brightness
end

#color_depth ⇒ Object

Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.



34
35
36
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 34

def color_depth
  @color_depth
end

#compression ⇒ Object

Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.



31
32
33
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 31

def compression
  @compression
end

#height ⇒ Object

Image height.



58
59
60
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 58

def height
  @height
end

#left_margin ⇒ Object

Left image margin.



37
38
39
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 37

def left_margin
  @left_margin
end

#orientation ⇒ Object

Image orientation. Possible values are: None, Landscape, Portait.



49
50
51
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 49

def orientation
  @orientation
end

#page_count ⇒ Object

Number of pages to export.



70
71
72
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 70

def page_count
  @page_count
end

#page_index ⇒ Object

Start page to export.



67
68
69
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 67

def page_index
  @page_index
end

#result_file ⇒ Object

Resulting image file.



73
74
75
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 73

def result_file
  @result_file
end

#right_margin ⇒ Object

Right image margin.



40
41
42
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 40

def right_margin
  @right_margin
end

#skip_blank_pages ⇒ Object

Skip blank pages flag.



52
53
54
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 52

def skip_blank_pages
  @skip_blank_pages
end

#top_margin ⇒ Object

Top image margin.



43
44
45
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 43

def top_margin
  @top_margin
end

#width ⇒ Object

Image width.



55
56
57
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 55

def width
  @width
end

#x_resolution ⇒ Object

Horizontal resolution.



61
62
63
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 61

def x_resolution
  @x_resolution
end

#y_resolution ⇒ Object

Vertical resolution.



64
65
66
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 64

def y_resolution
  @y_resolution
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 77

def self.attribute_map
  {
    :'brightness' => :'Brightness',
    :'compression' => :'Compression',
    :'color_depth' => :'ColorDepth',
    :'left_margin' => :'LeftMargin',
    :'right_margin' => :'RightMargin',
    :'top_margin' => :'TopMargin',
    :'bottom_margin' => :'BottomMargin',
    :'orientation' => :'Orientation',
    :'skip_blank_pages' => :'SkipBlankPages',
    :'width' => :'Width',
    :'height' => :'Height',
    :'x_resolution' => :'XResolution',
    :'y_resolution' => :'YResolution',
    :'page_index' => :'PageIndex',
    :'page_count' => :'PageCount',
    :'result_file' => :'ResultFile'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 99

def self.swagger_types
  {
    :'brightness' => :'Float',
    :'compression' => :'String',
    :'color_depth' => :'String',
    :'left_margin' => :'Integer',
    :'right_margin' => :'Integer',
    :'top_margin' => :'Integer',
    :'bottom_margin' => :'Integer',
    :'orientation' => :'String',
    :'skip_blank_pages' => :'BOOLEAN',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'x_resolution' => :'Integer',
    :'y_resolution' => :'Integer',
    :'page_index' => :'Integer',
    :'page_count' => :'Integer',
    :'result_file' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      brightness == o.brightness &&
      compression == o.compression &&
      color_depth == o.color_depth &&
      left_margin == o.left_margin &&
      right_margin == o.right_margin &&
      top_margin == o.top_margin &&
      bottom_margin == o.bottom_margin &&
      orientation == o.orientation &&
      skip_blank_pages == o.skip_blank_pages &&
      width == o.width &&
      height == o.height &&
      x_resolution == o.x_resolution &&
      y_resolution == o.y_resolution &&
      page_index == o.page_index &&
      page_count == o.page_count &&
      result_file == o.result_file
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 266

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 332

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 245

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


232
233
234
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 238

def hash
  [brightness, compression, color_depth, left_margin, right_margin, top_margin, bottom_margin, orientation, skip_blank_pages, width, height, x_resolution, y_resolution, page_index, page_count, result_file].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



196
197
198
199
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 196

def list_invalid_properties
  invalid_properties = Array.new
  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



312
313
314
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 312

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 318

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



306
307
308
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 306

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



203
204
205
 
# File 'lib/test_kaferi_cloud/models/tiff_export_options.rb', line 203

def valid?
  return true
end