Class Logger
Inherited Members
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Capture.dll
Syntax
public class Logger : BaseLoggerConstructors
Logger(string, int, int, string, LoggerSuffixOption, Func<string>)
Initializes a new instance of DataCapture logger with given params.
Declaration
public Logger(string logName, int bufferSize = 8192, int maxElapsedSeconds = 5, string userPath = "", LoggerSuffixOption suffixOption = LoggerSuffixOption.SEQ_NO, Func<string> customSuffix = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | logName | Name of the DataCapture Log file. |
| int | bufferSize | This corresponds to the file size (in KB). Default is set to 8192. |
| int | maxElapsedSeconds | |
| string | userPath | Location of the log file. Default is set to Application persistent path. |
| LoggerSuffixOption | suffixOption | |
| Func<string> | customSuffix |
Properties
bufferSize
Declaration
public int bufferSize { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Methods
Flushall(bool)
Flush data in the buffer to the file system right away. Usually it waits till the size of the buffer reaches to the bufferSize set.
Declaration
public void Flushall(bool synchronous = false)Parameters
| Type | Name | Description |
|---|---|---|
| bool | synchronous |
Log(object)
Logs the data to the file by appending it to the current buffer.
Declaration
public void Log(object parameters)Parameters
| Type | Name | Description |
|---|---|---|
| object | parameters | Serializable struct containing data to be captured. |