Files
quantconnect--lean/Logging/LogEntry.cs
T
2026-07-13 13:02:50 +08:00

76 lines
2.4 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
using System;
using System.Globalization;
namespace QuantConnect.Logging
{
/// <summary>
/// Log entry wrapper to make logging simpler:
/// </summary>
public class LogEntry
{
/// <summary>
/// Time of the log entry
/// </summary>
public DateTime Time { get; set; }
/// <summary>
/// Message of the log entry
/// </summary>
public string Message { get; set; }
/// <summary>
/// Descriptor of the message type.
/// </summary>
public LogType MessageType { get; set; }
/// <summary>
/// Create a default log message with the current time.
/// </summary>
/// <param name="message"></param>
public LogEntry(string message)
{
Time = DateTime.UtcNow;
Message = message;
MessageType = LogType.Trace;
}
/// <summary>
/// Create a log entry at a specific time in the analysis (for a backtest).
/// </summary>
/// <param name="message">Message for log</param>
/// <param name="time">Utc time of the message</param>
/// <param name="type">Type of the log entry</param>
public LogEntry(string message, DateTime time, LogType type = LogType.Trace)
{
Time = time;
Message = message;
MessageType = type;
}
/// <summary>
/// Helper override on the log entry.
/// </summary>
/// <returns></returns>
public override string ToString()
{
return $"{Time.ToString("o", CultureInfo.InvariantCulture)} {MessageType} {Message}";
}
}
}