Class: MistApi::WifiBeaconExtendedInfoItems

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

Overview

WifiBeaconExtendedInfoItems 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(frame_ctrl = SKIP, payload = SKIP, seq_ctrl = SKIP) ⇒ WifiBeaconExtendedInfoItems

Returns a new instance of WifiBeaconExtendedInfoItems.



47
48
49
50
51
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 47

def initialize(frame_ctrl = SKIP, payload = SKIP, seq_ctrl = SKIP)
  @frame_ctrl = frame_ctrl unless frame_ctrl == SKIP
  @payload = payload unless payload == SKIP
  @seq_ctrl = seq_ctrl unless seq_ctrl == SKIP
end

Instance Attribute Details

#frame_ctrl ⇒ Integer

Frame control field of 802.11 header

Returns:

  • (Integer) 


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

def frame_ctrl
  @frame_ctrl
end

#payload ⇒ String

Extended Info Payload associated with frame

Returns:

  • (String) 


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

def payload
  @payload
end

#seq_ctrl ⇒ Integer

Sequence control field of 802.11 header

Returns:

  • (Integer) 


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

def seq_ctrl
  @seq_ctrl
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  frame_ctrl = hash.key?('frame_ctrl') ? hash['frame_ctrl'] : SKIP
  payload = hash.key?('payload') ? hash['payload'] : SKIP
  seq_ctrl = hash.key?('seq_ctrl') ? hash['seq_ctrl'] : SKIP

  # Create object from extracted values.
  WifiBeaconExtendedInfoItems.new(frame_ctrl,
                                  payload,
                                  seq_ctrl)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['frame_ctrl'] = 'frame_ctrl'
  @_hash['payload'] = 'payload'
  @_hash['seq_ctrl'] = 'seq_ctrl'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    frame_ctrl
    payload
    seq_ctrl
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



70
71
72
73
74
75
76
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 70

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



85
86
87
88
89
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 85

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} frame_ctrl: #{@frame_ctrl.inspect}, payload: #{@payload.inspect}, seq_ctrl:"\
  " #{@seq_ctrl.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
 
# File 'lib/mist_api/models/wifi_beacon_extended_info_items.rb', line 79

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} frame_ctrl: #{@frame_ctrl}, payload: #{@payload}, seq_ctrl: #{@seq_ctrl}>"
end