Class: Comet::DiskDrive

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/disk_drive.rb

Overview

DiskDrive is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DiskDrive

Returns a new instance of DiskDrive.



65
66
67
 
# File 'lib/comet/models/disk_drive.rb', line 65

def initialize
  clear
end

Instance Attribute Details

#caption ⇒ Object

Returns the value of attribute caption.



22
23
24
 
# File 'lib/comet/models/disk_drive.rb', line 22

def caption
  @caption
end

#cylinders ⇒ Object

Deprecated.

This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.



49
50
51
 
# File 'lib/comet/models/disk_drive.rb', line 49

def cylinders
  @cylinders
end

#device_name ⇒ Object

Returns the value of attribute device_name.



19
20
21
 
# File 'lib/comet/models/disk_drive.rb', line 19

def device_name
  @device_name
end

#device_parents ⇒ Object

For physical disks, this array will be empty. For virtual disks, RAID devices or Linux DM devices, this array may contain the DeviceName of the parent device. This field is available in Comet 24.6.x and later.



41
42
43
 
# File 'lib/comet/models/disk_drive.rb', line 41

def device_parents
  @device_parents
end

#flags ⇒ Object

See WINDISKFLAG_ constants



45
46
47
 
# File 'lib/comet/models/disk_drive.rb', line 45

def flags
  @flags
end

#heads ⇒ Object

Deprecated.

This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.



53
54
55
 
# File 'lib/comet/models/disk_drive.rb', line 53

def heads
  @heads
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/comet/models/disk_drive.rb', line 16

def id
  @id
end

#model ⇒ Object

Returns the value of attribute model.



25
26
27
 
# File 'lib/comet/models/disk_drive.rb', line 25

def model
  @model
end

#partitions ⇒ Object

Returns the value of attribute partitions.



35
36
37
 
# File 'lib/comet/models/disk_drive.rb', line 35

def partitions
  @partitions
end

#sector_size ⇒ Object

Returns the value of attribute sector_size.



60
61
62
 
# File 'lib/comet/models/disk_drive.rb', line 60

def sector_size
  @sector_size
end

#sectors ⇒ Object

Deprecated.

This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.



57
58
59
 
# File 'lib/comet/models/disk_drive.rb', line 57

def sectors
  @sectors
end

#serial_number ⇒ Object

Returns the value of attribute serial_number.



28
29
30
 
# File 'lib/comet/models/disk_drive.rb', line 28

def serial_number
  @serial_number
end

#size ⇒ Object

Bytes



32
33
34
 
# File 'lib/comet/models/disk_drive.rb', line 32

def size
  @size
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



63
64
65
 
# File 'lib/comet/models/disk_drive.rb', line 63

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @id = ''
  @device_name = ''
  @caption = ''
  @model = ''
  @serial_number = ''
  @size = 0
  @partitions = []
  @device_parents = []
  @flags = 0
  @cylinders = 0
  @heads = 0
  @sectors = 0
  @sector_size = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/comet/models/disk_drive.rb', line 94

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'ID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @id = v
    when 'DeviceName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @device_name = v
    when 'Caption'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @caption = v
    when 'Model'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @model = v
    when 'SerialNumber'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @serial_number = v
    when 'Size'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @size = v
    when 'Partitions'
      if v.nil?
        @partitions = []
      else
        @partitions = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @partitions[i1] = Comet::Partition.new
          @partitions[i1].from_hash(v1)
        end
      end
    when 'DeviceParents'
      if v.nil?
        @device_parents = []
      else
        @device_parents = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @device_parents[i1] = v1
        end
      end
    when 'Flags'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @flags = v
    when 'Cylinders'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @cylinders = v
    when 'Heads'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @heads = v
    when 'Sectors'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @sectors = v
    when 'SectorSize'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @sector_size = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


87
88
89
90
91
 
# File 'lib/comet/models/disk_drive.rb', line 87

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



193
194
195
 
# File 'lib/comet/models/disk_drive.rb', line 193

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/comet/models/disk_drive.rb', line 171

def to_hash
  ret = {}
  ret['ID'] = @id
  ret['DeviceName'] = @device_name
  ret['Caption'] = @caption
  ret['Model'] = @model
  ret['SerialNumber'] = @serial_number
  ret['Size'] = @size
  ret['Partitions'] = @partitions
  ret['DeviceParents'] = @device_parents
  ret['Flags'] = @flags
  ret['Cylinders'] = @cylinders
  ret['Heads'] = @heads
  ret['Sectors'] = @sectors
  ret['SectorSize'] = @sector_size
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



198
199
200
 
# File 'lib/comet/models/disk_drive.rb', line 198

def to_json(options = {})
  to_hash.to_json(options)
end