Class: MistApi::ConstApChannel

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

Overview

ConstApChannel 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(band24_40mhz_allowed = SKIP, band24_channels = SKIP, band24_enabled = SKIP, band5_channels = SKIP, band5_enabled = SKIP, band6_channels = SKIP, band6_enabled = SKIP, certified = SKIP, code = SKIP, dfs_ok = SKIP, key = SKIP, name = SKIP, uses = SKIP) ⇒ ConstApChannel

Returns a new instance of ConstApChannel.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/mist_api/models/const_ap_channel.rb', line 107

def initialize(band24_40mhz_allowed = SKIP, band24_channels = SKIP,
               band24_enabled = SKIP, band5_channels = SKIP,
               band5_enabled = SKIP, band6_channels = SKIP,
               band6_enabled = SKIP, certified = SKIP, code = SKIP,
               dfs_ok = SKIP, key = SKIP, name = SKIP, uses = SKIP)
  @band24_40mhz_allowed = band24_40mhz_allowed unless band24_40mhz_allowed == SKIP
  @band24_channels = band24_channels unless band24_channels == SKIP
  @band24_enabled = band24_enabled unless band24_enabled == SKIP
  @band5_channels = band5_channels unless band5_channels == SKIP
  @band5_enabled = band5_enabled unless band5_enabled == SKIP
  @band6_channels = band6_channels unless band6_channels == SKIP
  @band6_enabled = band6_enabled unless band6_enabled == SKIP
  @certified = certified unless certified == SKIP
  @code = code unless code == SKIP
  @dfs_ok = dfs_ok unless dfs_ok == SKIP
  @key = key unless key == SKIP
  @name = name unless name == SKIP
  @uses = uses unless uses == SKIP
end

Instance Attribute Details

#band24_40mhz_allowedTrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass)


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

def band24_40mhz_allowed
  @band24_40mhz_allowed
end

#band24_channelsArray[Integer]

Property key is the channel width

Returns:

  • (Array[Integer])


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

def band24_channels
  @band24_channels
end

#band24_enabledTrueClass | FalseClass

Property key is the channel width

Returns:

  • (TrueClass | FalseClass)


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

def band24_enabled
  @band24_enabled
end

#band5_channelsArray[Integer]

Property key is the channel width

Returns:

  • (Array[Integer])


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

def band5_channels
  @band5_channels
end

#band5_enabledTrueClass | FalseClass

Property key is the channel width

Returns:

  • (TrueClass | FalseClass)


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

def band5_enabled
  @band5_enabled
end

#band6_channelsArray[Integer]

Property key is the channel width

Returns:

  • (Array[Integer])


34
35
36
# File 'lib/mist_api/models/const_ap_channel.rb', line 34

def band6_channels
  @band6_channels
end

#band6_enabledTrueClass | FalseClass

Property key is the channel width

Returns:

  • (TrueClass | FalseClass)


38
39
40
# File 'lib/mist_api/models/const_ap_channel.rb', line 38

def band6_enabled
  @band6_enabled
end

#certifiedTrueClass | FalseClass

Property key is the channel width

Returns:

  • (TrueClass | FalseClass)


42
43
44
# File 'lib/mist_api/models/const_ap_channel.rb', line 42

def certified
  @certified
end

#codeInteger

Country code, ISO 3166-1 numeric

Returns:

  • (Integer)


46
47
48
# File 'lib/mist_api/models/const_ap_channel.rb', line 46

def code
  @code
end

#dfs_okTrueClass | FalseClass

Country code, ISO 3166-1 numeric

Returns:

  • (TrueClass | FalseClass)


50
51
52
# File 'lib/mist_api/models/const_ap_channel.rb', line 50

def dfs_ok
  @dfs_ok
end

#keyString

Country code, in two-character

Returns:

  • (String)


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

def key
  @key
end

#nameString

Country code, in two-character

Returns:

  • (String)


58
59
60
# File 'lib/mist_api/models/const_ap_channel.rb', line 58

def name
  @name
end

#usesString

Country code, in two-character

Returns:

  • (String)


62
63
64
# File 'lib/mist_api/models/const_ap_channel.rb', line 62

def uses
  @uses
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
# File 'lib/mist_api/models/const_ap_channel.rb', line 128

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  band24_40mhz_allowed =
    hash.key?('band24_40mhz_allowed') ? hash['band24_40mhz_allowed'] : SKIP
  band24_channels =
    hash.key?('band24_channels') ? hash['band24_channels'] : SKIP
  band24_enabled =
    hash.key?('band24_enabled') ? hash['band24_enabled'] : SKIP
  band5_channels =
    hash.key?('band5_channels') ? hash['band5_channels'] : SKIP
  band5_enabled = hash.key?('band5_enabled') ? hash['band5_enabled'] : SKIP
  band6_channels =
    hash.key?('band6_channels') ? hash['band6_channels'] : SKIP
  band6_enabled = hash.key?('band6_enabled') ? hash['band6_enabled'] : SKIP
  certified = hash.key?('certified') ? hash['certified'] : SKIP
  code = hash.key?('code') ? hash['code'] : SKIP
  dfs_ok = hash.key?('dfs_ok') ? hash['dfs_ok'] : SKIP
  key = hash.key?('key') ? hash['key'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP
  uses = hash.key?('uses') ? hash['uses'] : SKIP

  # Create object from extracted values.
  ConstApChannel.new(band24_40mhz_allowed,
                     band24_channels,
                     band24_enabled,
                     band5_channels,
                     band5_enabled,
                     band6_channels,
                     band6_enabled,
                     certified,
                     code,
                     dfs_ok,
                     key,
                     name,
                     uses)
end

.namesObject

A mapping from model property names to API property names.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/mist_api/models/const_ap_channel.rb', line 65

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['band24_40mhz_allowed'] = 'band24_40mhz_allowed'
  @_hash['band24_channels'] = 'band24_channels'
  @_hash['band24_enabled'] = 'band24_enabled'
  @_hash['band5_channels'] = 'band5_channels'
  @_hash['band5_enabled'] = 'band5_enabled'
  @_hash['band6_channels'] = 'band6_channels'
  @_hash['band6_enabled'] = 'band6_enabled'
  @_hash['certified'] = 'certified'
  @_hash['code'] = 'code'
  @_hash['dfs_ok'] = 'dfs_ok'
  @_hash['key'] = 'key'
  @_hash['name'] = 'name'
  @_hash['uses'] = 'uses'
  @_hash
end

.nullablesObject

An array for nullable fields



103
104
105
# File 'lib/mist_api/models/const_ap_channel.rb', line 103

def self.nullables
  []
end

.optionalsObject

An array for optional fields



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/mist_api/models/const_ap_channel.rb', line 84

def self.optionals
  %w[
    band24_40mhz_allowed
    band24_channels
    band24_enabled
    band5_channels
    band5_enabled
    band6_channels
    band6_enabled
    certified
    code
    dfs_ok
    key
    name
    uses
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



178
179
180
181
182
183
184
185
186
# File 'lib/mist_api/models/const_ap_channel.rb', line 178

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} band24_40mhz_allowed: #{@band24_40mhz_allowed.inspect}, band24_channels:"\
  " #{@band24_channels.inspect}, band24_enabled: #{@band24_enabled.inspect}, band5_channels:"\
  " #{@band5_channels.inspect}, band5_enabled: #{@band5_enabled.inspect}, band6_channels:"\
  " #{@band6_channels.inspect}, band6_enabled: #{@band6_enabled.inspect}, certified:"\
  " #{@certified.inspect}, code: #{@code.inspect}, dfs_ok: #{@dfs_ok.inspect}, key:"\
  " #{@key.inspect}, name: #{@name.inspect}, uses: #{@uses.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



168
169
170
171
172
173
174
175
# File 'lib/mist_api/models/const_ap_channel.rb', line 168

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} band24_40mhz_allowed: #{@band24_40mhz_allowed}, band24_channels:"\
  " #{@band24_channels}, band24_enabled: #{@band24_enabled}, band5_channels:"\
  " #{@band5_channels}, band5_enabled: #{@band5_enabled}, band6_channels: #{@band6_channels},"\
  " band6_enabled: #{@band6_enabled}, certified: #{@certified}, code: #{@code}, dfs_ok:"\
  " #{@dfs_ok}, key: #{@key}, name: #{@name}, uses: #{@uses}>"
end