Class: VBox::Progress

Inherits:
Base
  • Object
show all
Defined in:
lib/virtualbox/classes/progress.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#_this, #delete!, #ensure_hash, #initialize, #vbox_class

Constructor Details

This class inherits a constructor from VBox::Base

Instance Attribute Details

#ref ⇒ Object (readonly)

Returns the value of attribute ref.



4
5
6
 
# File 'lib/virtualbox/classes/progress.rb', line 4

def ref
  @ref
end

Instance Method Details

#cancel ⇒ Object

Methods



79
80
81
 
# File 'lib/virtualbox/classes/progress.rb', line 79

def cancel
  VBox::WebService.send_request(:i_progress_cancel, _this)
end

#cancelable ⇒ Object 



20
21
22
 
# File 'lib/virtualbox/classes/progress.rb', line 20

def cancelable
  VBox::WebService.send_request(:i_progress_get_cancelable, _this)
end

#canceled ⇒ Object 



36
37
38
 
# File 'lib/virtualbox/classes/progress.rb', line 36

def canceled
  VBox::WebService.send_request(:i_progress_get_canceled, _this)
end

#completed ⇒ Object 



32
33
34
 
# File 'lib/virtualbox/classes/progress.rb', line 32

def completed
  VBox::WebService.send_request(:i_progress_get_completed, _this)
end

#description ⇒ Object 



12
13
14
 
# File 'lib/virtualbox/classes/progress.rb', line 12

def description
  VBox::WebService.send_request(:i_progress_get_description, _this)
end

#error_info ⇒ Object 



44
45
46
47
 
# File 'lib/virtualbox/classes/progress.rb', line 44

def error_info
  error_info = VBox::WebService.send_request(:i_progress_get_error_info, _this)
  VBox::VirtualBoxErrorInfo.new(error_info)
end

#id ⇒ Object

Attributes



8
9
10
 
# File 'lib/virtualbox/classes/progress.rb', line 8

def id
  VBox::WebService.send_request(:i_progress_get_id, _this)
end

#initiator ⇒ Object 



16
17
18
 
# File 'lib/virtualbox/classes/progress.rb', line 16

def initiator
  VBox::WebService.send_request(:i_progress_get_initiator, _this)
end

#operation ⇒ Object 



53
54
55
 
# File 'lib/virtualbox/classes/progress.rb', line 53

def operation
  VBox::WebService.send_request(:i_progress_get_operation, _this)
end

#operation_count ⇒ Object 



49
50
51
 
# File 'lib/virtualbox/classes/progress.rb', line 49

def operation_count
  VBox::WebService.send_request(:i_progress_get_operation_count, _this)
end

#operation_description ⇒ Object 



57
58
59
 
# File 'lib/virtualbox/classes/progress.rb', line 57

def operation_description
  VBox::WebService.send_request(:i_progress_get_operation_description, _this)
end

#operation_percent ⇒ Object 



61
62
63
 
# File 'lib/virtualbox/classes/progress.rb', line 61

def operation_percent
  VBox::WebService.send_request(:i_progress_get_operation_percent, _this)
end

#operation_weight ⇒ Object 



65
66
67
 
# File 'lib/virtualbox/classes/progress.rb', line 65

def operation_weight
  VBox::WebService.send_request(:i_progress_get_operation_weight, _this)
end

#percent ⇒ Object 



24
25
26
 
# File 'lib/virtualbox/classes/progress.rb', line 24

def percent
  VBox::WebService.send_request(:i_progress_get_percent, _this)
end

#result_code ⇒ Object 



40
41
42
 
# File 'lib/virtualbox/classes/progress.rb', line 40

def result_code
  VBox::WebService.send_request(:i_progress_get_result_code, _this)
end

#set_current_operation_progress(args = {}) ⇒ Object 



83
84
85
86
 
# File 'lib/virtualbox/classes/progress.rb', line 83

def set_current_operation_progress(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_progress_set_current_operation_progress, _this.merge(args))
end

#set_next_operation(args = {}) ⇒ Object 



88
89
90
91
 
# File 'lib/virtualbox/classes/progress.rb', line 88

def set_next_operation(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_progress_set_next_operation, _this.merge(args))
end

#time_remaining ⇒ Object 



28
29
30
 
# File 'lib/virtualbox/classes/progress.rb', line 28

def time_remaining
  VBox::WebService.send_request(:i_progress_get_time_remaining, _this)
end

#timeout ⇒ Object 



69
70
71
 
# File 'lib/virtualbox/classes/progress.rb', line 69

def timeout
  VBox::WebService.send_request(:i_progress_get_timeout, _this)
end

#timeout=(timeout) ⇒ Object 



73
74
75
 
# File 'lib/virtualbox/classes/progress.rb', line 73

def timeout=(timeout)
  VBox::WebService.send_request(:i_progress_set_timeout, _this.merge(:timeout => timeout))
end

#wait_for_async_progress_completion(args = {}) ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/virtualbox/classes/progress.rb', line 93

def wait_for_async_progress_completion(args={})
  ensure_hash(args)
  if args.has_key?(:p_progress_async) & args[:p_progress_async].respond_to?(:ref)
    args[:p_progress_async] = args[:p_progress_async].ref
  end
  VBox::WebService.send_request(:i_progress_wait_for_async_progress_completion, _this.merge(args))
end

#wait_for_completion(args = {}) ⇒ Object 



101
102
103
104
 
# File 'lib/virtualbox/classes/progress.rb', line 101

def wait_for_completion(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_progress_wait_for_completion, _this.merge(args))
end

#wait_for_operation_completion(args = {}) ⇒ Object 



106
107
108
109
 
# File 'lib/virtualbox/classes/progress.rb', line 106

def wait_for_operation_completion(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_progress_wait_for_operation_completion, _this.merge(args))
end