Class: MistApi::MapOrgImportFileJson

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/map_org_import_file_json.rb

Overview

MapOrgImportFileJson Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(vendor_name = nil, import_all_floorplans = false, import_height = true, import_orientation = true, site_id = SKIP) ⇒ MapOrgImportFileJson

Returns a new instance of MapOrgImportFileJson.



58
59
60
61
62
63
64
65
66
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 58

def initialize(vendor_name = nil, import_all_floorplans = false,
               import_height = true, import_orientation = true,
               site_id = SKIP)
  @import_all_floorplans = import_all_floorplans unless import_all_floorplans == SKIP
  @import_height = import_height unless import_height == SKIP
  @import_orientation = import_orientation unless import_orientation == SKIP
  @site_id = site_id unless site_id == SKIP
  @vendor_name = vendor_name
end

Instance Attribute Details

#import_all_floorplans ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


14
15
16
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 14

def import_all_floorplans
  @import_all_floorplans
end

#import_height ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 18

def import_height
  @import_height
end

#import_orientation ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


22
23
24
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 22

def import_orientation
  @import_orientation
end

#site_id ⇒ UUID | String

TODO: Write general description for this method

Returns:

  • (UUID | String) 


26
27
28
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 26

def site_id
  @site_id
end

#vendor_name ⇒ MapOrgImportFileJsonVendorNameEnum

enum: ‘ekahau`, `ibwave`

Returns:



30
31
32
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 30

def vendor_name
  @vendor_name
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 69

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  vendor_name = hash.key?('vendor_name') ? hash['vendor_name'] : nil
  import_all_floorplans = hash['import_all_floorplans'] ||= false
  import_height = hash['import_height'] ||= true
  import_orientation = hash['import_orientation'] ||= true
  site_id = hash.key?('site_id') ? hash['site_id'] : SKIP

  # Create object from extracted values.
  MapOrgImportFileJson.new(vendor_name,
                           import_all_floorplans,
                           import_height,
                           import_orientation,
                           site_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['import_all_floorplans'] = 'import_all_floorplans'
  @_hash['import_height'] = 'import_height'
  @_hash['import_orientation'] = 'import_orientation'
  @_hash['site_id'] = 'site_id'
  @_hash['vendor_name'] = 'vendor_name'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



54
55
56
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 54

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
49
50
51
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 44

def self.optionals
  %w[
    import_all_floorplans
    import_height
    import_orientation
    site_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



96
97
98
99
100
101
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 96

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} import_all_floorplans: #{@import_all_floorplans.inspect}, import_height:"\
  " #{@import_height.inspect}, import_orientation: #{@import_orientation.inspect}, site_id:"\
  " #{@site_id.inspect}, vendor_name: #{@vendor_name.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



88
89
90
91
92
93
 
# File 'lib/mist_api/models/map_org_import_file_json.rb', line 88

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} import_all_floorplans: #{@import_all_floorplans}, import_height:"\
  " #{@import_height}, import_orientation: #{@import_orientation}, site_id: #{@site_id},"\
  " vendor_name: #{@vendor_name}>"
end