QuantConnect.Packets.DebugPacket Class Reference

Send a simple debug message from the users algorithm to the console. More...

Inheritance diagram for QuantConnect.Packets.DebugPacket:

Public Member Functions
	DebugPacket ()
	Default constructor for JSON More...
	DebugPacket (int projectId, string algorithmId, string compileId, string message, bool toast=false)
	Create a new instance of the notify debug packet: More...
Public Member Functions inherited from QuantConnect.Packets.Packet
	Packet (PacketType type)
	Initialize the base class and setup the packet type. More...

Protected Member Functions
	DebugPacket (PacketType packetType)
	Constructor for inherited types More...

Properties
string	Message [get, set]
	String debug message to send to the users console More...
string	AlgorithmId [get, set]
	Associated algorithm Id. More...
string	CompileId [get, set]
	Compile id of the algorithm sending this message More...
int	ProjectId [get, set]
	Project Id for this message More...
bool	Toast [get, set]
	True to emit message as a popup notification (toast), false to emit message in console as text More...
Properties inherited from QuantConnect.Packets.Packet
PacketType	Type = PacketType.None [get, set]
	Packet type defined by a string enum More...
virtual string	Channel = "" [get, set]
	User unique specific channel endpoint to send the packets More...

Detailed Description

Send a simple debug message from the users algorithm to the console.

Definition at line 24 of file DebugPacket.cs.

Constructor & Destructor Documentation

DebugPacket() [1/3]

QuantConnect.Packets.DebugPacket.DebugPacket

(

)

Default constructor for JSON

Definition at line 55 of file DebugPacket.cs.

DebugPacket() [2/3]

QuantConnect.Packets.DebugPacket.DebugPacket ( PacketType  packetType )

protected

Constructor for inherited types

Parameters

packetType

The type of packet to create

Definition at line 63 of file DebugPacket.cs.

DebugPacket() [3/3]

QuantConnect.Packets.DebugPacket.DebugPacket	(	int	projectId,
		string	algorithmId,
		string	compileId,
		string	message,
		bool	toast = false
	)

Create a new instance of the notify debug packet:

Definition at line 70 of file DebugPacket.cs.

Property Documentation

Message

string QuantConnect.Packets.DebugPacket.Message

getset

String debug message to send to the users console

Definition at line 29 of file DebugPacket.cs.

AlgorithmId

string QuantConnect.Packets.DebugPacket.AlgorithmId

getset

Associated algorithm Id.

Definition at line 34 of file DebugPacket.cs.

CompileId

string QuantConnect.Packets.DebugPacket.CompileId

getset

Compile id of the algorithm sending this message

Definition at line 39 of file DebugPacket.cs.

ProjectId

int QuantConnect.Packets.DebugPacket.ProjectId

getset

Project Id for this message

Definition at line 44 of file DebugPacket.cs.

Toast

bool QuantConnect.Packets.DebugPacket.Toast

getset

True to emit message as a popup notification (toast), false to emit message in console as text

Definition at line 50 of file DebugPacket.cs.

---

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

• Common/Packets/DebugPacket.cs