EventLog
Description
A class that provides access to the event log.
Using the EventLog class, you can add custom events to the Event Log.
EventLog.info("MyCustomEvent");
if (/*something is unusual*/) {
EventLog.warn("MyCustomEvent", 0, 0, "Something is unusual");
}
if (/*something is wrong*/) {
EventLog.error("MyCustomEvent", 0, 0, "Something is wrong");
}
if (/*something is terribly wrong*/) {
EventLog.fatal("MyCustomEvent", 0, 0, "Something is terribly wrong");
}
The logging methods are:
- info()
- warn()
- error()
- fatal()
The only required parameter for the logging methods is the event
parameter. It is best to use a short but meaningful name so that filtering by the
event makes sense. The remainder of the parameters (two node parameters and four
string parameters) are optional and arbitrary.
You can check whether any logs are active using the enabled
property:
if (EventLog.enabled) {
string p1 = /*expensive computation*/;
EventLog.info("MyCustomEvent", 0, 0, p1);
}
Static Properties
enabled | Returns whether logging is currently enabled. |
Static Methods
error | Log an Error-level event at the current time. |
fatal | Log a Fatal-level event at the current time. |
info | Log an Info-level event at the current time. |
warn | Log a Warn-level event at the current time. |
Details
Do no remove, this fixes the anchor on doc.flexsim.com
Do no remove, this fixes the anchor on doc.flexsim.com
EventLog.error()
static error( string event , treenode object = 0 , treenode involved = 0 , string p1 = "" , string p2 = "" , string p3 = "" , string p4 = "" ) |
Parameters
event | The name of the event. |
object | The primary object associated with the event. |
involved | The involved object associated with the event. |
p1 | Data for P1 associated with the event. |
p2 | Data for P2 associated with the event. |
p3 | Data for P3 associated with the event. |
p4 | Data for P4 associated with the event. |
Description
Log an Error-level event at the current time.
Error-level events are often used to indicate that the simulation cannot continue or that the results are invalid. Consider stopping the simulation manually if you log an Error-level event.Do no remove, this fixes the anchor on doc.flexsim.com
EventLog.fatal()
static fatal( string event , treenode object = 0 , treenode involved = 0 , string p1 = "" , string p2 = "" , string p3 = "" , string p4 = "" ) |
Parameters
event | The name of the event. |
object | The primary object associated with the event. |
involved | The involved object associated with the event. |
p1 | Data for P1 associated with the event. |
p2 | Data for P2 associated with the event. |
p3 | Data for P3 associated with the event. |
p4 | Data for P4 associated with the event. |
Description
Log a Fatal-level event at the current time.
Fatal-level events are often used to indicate that data loss or corruption has occurred.Do no remove, this fixes the anchor on doc.flexsim.com
EventLog.info()
static info( string event , treenode object = 0 , treenode involved = 0 , string p1 = "" , string p2 = "" , string p3 = "" , string p4 = "" ) |
Parameters
event | The name of the event. |
object | The primary object associated with the event. |
involved | The involved object associated with the event. |
p1 | Data for P1 associated with the event. |
p2 | Data for P2 associated with the event. |
p3 | Data for P3 associated with the event. |
p4 | Data for P4 associated with the event. |
Description
Log an Info-level event at the current time.
Info-level events are often used to indicate that something normal or expected has occurred. All model logic events are Info-level events.Do no remove, this fixes the anchor on doc.flexsim.com
EventLog.warn()
static warn( string event , treenode object = 0 , treenode involved = 0 , string p1 = "" , string p2 = "" , string p3 = "" , string p4 = "" ) |
Parameters
event | The name of the event. |
object | The primary object associated with the event. |
involved | The involved object associated with the event. |
p1 | Data for P1 associated with the event. |
p2 | Data for P2 associated with the event. |
p3 | Data for P3 associated with the event. |
p4 | Data for P4 associated with the event. |
Description
Log a Warn-level event at the current time.
Warn-level events are often used to indicate that something unexpected has occurred but that the simulation can continue to operate.