MyCaffe  1.11.8.27
Deep learning software for Windows C# programmers.
MyCaffe.basecode.LogArg Class Reference

The LogArg is passed as an argument to the Log::OnWriteLine event. More...

Inheritance diagram for MyCaffe.basecode.LogArg:
MyCaffe.basecode.LogProgressArg

Public Member Functions

 LogArg (string strSrc, string strMsg, double dfProgress=0.0, bool bError=false, bool bOverrideEnabled=false, bool bDisable=false)
 The LogArg constructor. More...
 
- Public Member Functions inherited from MyCaffe.basecode.LogProgressArg
 LogProgressArg (string strSrc, double dfProgress)
 The LogProgressArg constructor. More...
 

Properties

bool Consumed [getset]
 Specifies whether or not the message has already been consumed. More...
 
bool Disable [getset]
 Specifies whether or not to mark this log entry as disabled so that it is not output. More...
 
string Message [get]
 Returns the message logged. More...
 
bool Error [get]
 Returns whether or not this is an error message. More...
 
bool OverrideEnabled [get]
 Returns whether or not the override was enabled or not. More...
 
- Properties inherited from MyCaffe.basecode.LogProgressArg
string Source [get]
 Returns the Log source name. More...
 
double Progress [get]
 Returns the progress value. More...
 

Detailed Description

The LogArg is passed as an argument to the Log::OnWriteLine event.

Definition at line 51 of file EventArgs.cs.

Constructor & Destructor Documentation

◆ LogArg()

MyCaffe.basecode.LogArg.LogArg ( string  strSrc,
string  strMsg,
double  dfProgress = 0.0,
bool  bError = false,
bool  bOverrideEnabled = false,
bool  bDisable = false 
)

The LogArg constructor.

Parameters
strSrcSpecifies the Log source name.
strMsgSpecifies the message written when calling the Log::WriteLine function (which triggers the event).
dfProgressSpecifies the progress value specifies when setting the Log::Progress value.
bErrorSpecifies whether or not the message is the result of a call from Log::WriteError.
bOverrideEnabledSpecifies whether or not the log override was used.
bDisableSpecifies whether or not to disable the output of the message (e.g. used internally).

Definition at line 69 of file EventArgs.cs.

Property Documentation

◆ Consumed

bool MyCaffe.basecode.LogArg.Consumed
getset

Specifies whether or not the message has already been consumed.

Definition at line 81 of file EventArgs.cs.

◆ Disable

bool MyCaffe.basecode.LogArg.Disable
getset

Specifies whether or not to mark this log entry as disabled so that it is not output.

Definition at line 90 of file EventArgs.cs.

◆ Error

bool MyCaffe.basecode.LogArg.Error
get

Returns whether or not this is an error message.

Definition at line 107 of file EventArgs.cs.

◆ Message

string MyCaffe.basecode.LogArg.Message
get

Returns the message logged.

Definition at line 99 of file EventArgs.cs.

◆ OverrideEnabled

bool MyCaffe.basecode.LogArg.OverrideEnabled
get

Returns whether or not the override was enabled or not.

Definition at line 115 of file EventArgs.cs.


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