BioCore.Progress Class Reference

Inheritance diagram for BioCore.Progress:

Public Member Functions
	Progress (string file, string status)
void	UpdateProgress (int p)
void	UpdateProgressF (float p)

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.

Properties
string	Status [get, set]

Detailed Description

Definition at line 3 of file Progress.Designer.cs.

Constructor & Destructor Documentation

Progress()

BioCore.Progress.Progress	(	string	file,
		string	status )

Definition at line 10 of file Progress.cs.

        {
            InitializeComponent();
            watch.Start();
            statusLabel.Text = status;
            fileLabel.Text = file;
            timer.Start();
        }

Member Function Documentation

Dispose()

override void BioCore.Progress.Dispose ( bool disposing )

protected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 14 of file Progress.Designer.cs.

        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

UpdateProgress()

void BioCore.Progress.UpdateProgress

(

int

p

)

The function takes an integer as a parameter and sets the value of the progress bar to that integer

Parameters

p	The progress value.

Definition at line 22 of file Progress.cs.

        {
            progressBar.Value = p;
        }

UpdateProgressF()

void BioCore.Progress.UpdateProgressF

(

float

p

)

If the progress is greater than 1, set the progress bar to 100, otherwise set the progress bar to the progress times 100

Parameters

p	The progress value.

Definition at line 30 of file Progress.cs.

        {
            if (p > 1)
                progressBar.Value = 100;
            else
                progressBar.Value = (int)(p * 100);
        }

Property Documentation

Status

string BioCore.Progress.Status

getset

Definition at line 48 of file Progress.cs.

        {  
            get { return statusLabel.Text; } 
            set { statusLabel.Text = value; }
        }

---

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

• BioCore/BioCore/Source/Progress.cs
• BioCore/BioCore/Source/Progress.Designer.cs