The ProgressInfo is used when reporting the overall progress of creating a dataset. More...

Public Member Functions
	ProgressInfo (long nIdx, long nTotal, string str, Exception err=null, bool? bAlive=null)
	The constructor. More...

Properties
long	Index `[get]`
	Return the current index in the process. More...

long	Total `[get]`
	Return the total items to process. More...

double?	Percentage `[get]`
	Returns the percentage of the current process. More...

string	Message `[get]`
	Returns the message as a string. More...

Exception	Error `[get]`
	Returns the error if one occurred, or null. More...

bool?	Alive `[getset]`
	Returns whether or not the process is alive or not. More...

Detailed Description

The ProgressInfo is used when reporting the overall progress of creating a dataset.

Definition at line 16 of file ProgressInfo.cs.

Constructor & Destructor Documentation

◆ ProgressInfo()

MyCaffe.data.ProgressInfo.ProgressInfo	(	long	nIdx,
		long	nTotal,
		string	str,
		Exception	err = `null`,
		bool?	bAlive = `null`
	)

The constructor.

Parameters

nIdx	Specifies the current index in the process.
nTotal	Specifies the total items to process.
str	Specifies the message to display.
err	Specifies an error if one occurred, or null.
bAlive	Specifies whether or not the process is alive.

Definition at line 32 of file ProgressInfo.cs.

Property Documentation

◆ Alive

bool? MyCaffe.data.ProgressInfo.Alive

getset

Returns whether or not the process is alive or not.

Definition at line 84 of file ProgressInfo.cs.

◆ Error

Exception MyCaffe.data.ProgressInfo.Error

get

Returns the error if one occurred, or null.

Definition at line 76 of file ProgressInfo.cs.

◆ Index

long MyCaffe.data.ProgressInfo.Index

get

Return the current index in the process.

Definition at line 44 of file ProgressInfo.cs.

◆ Message

string MyCaffe.data.ProgressInfo.Message

get

Returns the message as a string.

Definition at line 68 of file ProgressInfo.cs.

◆ Percentage

double? MyCaffe.data.ProgressInfo.Percentage

get

Returns the percentage of the current process.

Definition at line 60 of file ProgressInfo.cs.

◆ Total

long MyCaffe.data.ProgressInfo.Total

get

Return the total items to process.

Definition at line 52 of file ProgressInfo.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.data/ProgressInfo.cs

Public Member Functions

Properties