rxbag::util::progress_meter::ProgressMeter Class Reference

List of all members.

Public Member Functions
def	__init__
def	approximate_size
def	finish
def	step
def	terminal_width
Public Attributes
	bytes_read
	bytes_total
	elapsed
	path
	refresh_rate
	start_time
	update_elapsed
Static Public Attributes
dictionary	SUFFIXES
Private Member Functions
def	_update_progress

---

Detailed Description

Definition at line 36 of file progress_meter.py.

---

Member Function Documentation

def rxbag::util::progress_meter::ProgressMeter::__init__	(		self,
			path,
			bytes_total,
			refresh_rate = 1.0
	)

Definition at line 40 of file progress_meter.py.

def rxbag::util::progress_meter::ProgressMeter::_update_progress

(

self

)

[private]

Definition at line 61 of file progress_meter.py.

def rxbag::util::progress_meter::ProgressMeter::approximate_size	(		cls,
			size,
			a_kilobyte_is_1024_bytes = False
	)

Convert file size to human-readable form

Definition at line 96 of file progress_meter.py.

def rxbag::util::progress_meter::ProgressMeter::finish

(

self

)

Definition at line 91 of file progress_meter.py.

def rxbag::util::progress_meter::ProgressMeter::step	(		self,
			bytes_read,
			force_update = False
	)

Definition at line 53 of file progress_meter.py.

def rxbag::util::progress_meter::ProgressMeter::terminal_width

(

)

Estimate the width of the terminal

Definition at line 112 of file progress_meter.py.

---

Member Data Documentation

rxbag::util::progress_meter::ProgressMeter::bytes_read

Definition at line 47 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::bytes_total

Definition at line 42 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::elapsed

Definition at line 45 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::path

Definition at line 41 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::refresh_rate

Definition at line 43 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::start_time

Definition at line 49 of file progress_meter.py.

dictionary rxbag::util::progress_meter::ProgressMeter::SUFFIXES [static]

Initial value:

{ 1000: ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'],
                 1024: ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'] }

Definition at line 37 of file progress_meter.py.

rxbag::util::progress_meter::ProgressMeter::update_elapsed

Definition at line 46 of file progress_meter.py.

---

The documentation for this class was generated from the following file:

• progress_meter.py