Lean  $LEAN_TAG$
QuantConnect.Orders.OrderRequest Class Reference

Represents a request to submit, update, or cancel an order More...

Inheritance diagram for QuantConnect.Orders.OrderRequest:
[legend]

Public Member Functions

void SetResponse (OrderResponse response, OrderRequestStatus status=OrderRequestStatus.Error)
 Sets the Response for this request More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Protected Member Functions

 OrderRequest (DateTime time, int orderId, string tag)
 Initializes a new instance of the OrderRequest class More...
 

Properties

abstract OrderRequestType OrderRequestType [get]
 Gets the type of this order request More...
 
OrderRequestStatus Status [get]
 Gets the status of this request More...
 
DateTime Time [get]
 Gets the UTC time the request was created More...
 
int OrderId [get, protected set]
 Gets the order id the request acts on More...
 
string Tag [get]
 Gets a tag for this request More...
 
OrderResponse Response [get]
 Gets the response for this request. If this request was never processed then this will equal OrderResponse.Unprocessed. This value is never equal to null. More...
 

Detailed Description

Represents a request to submit, update, or cancel an order

Definition at line 23 of file OrderRequest.cs.

Constructor & Destructor Documentation

◆ OrderRequest()

QuantConnect.Orders.OrderRequest.OrderRequest ( DateTime  time,
int  orderId,
string  tag 
)
protected

Initializes a new instance of the OrderRequest class

Parameters
timeThe time this request was created
orderIdThe order id this request acts on, specify zero for SubmitOrderRequest
tagA custom tag for the request

Definition at line 80 of file OrderRequest.cs.

Member Function Documentation

◆ SetResponse()

void QuantConnect.Orders.OrderRequest.SetResponse ( OrderResponse  response,
OrderRequestStatus  status = OrderRequestStatus.Error 
)

Sets the Response for this request

Parameters
responseThe response to this request
statusThe current status of this request

Definition at line 94 of file OrderRequest.cs.

Here is the caller graph for this function:

◆ ToString()

override string QuantConnect.Orders.OrderRequest.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 113 of file OrderRequest.cs.

Property Documentation

◆ OrderRequestType

abstract OrderRequestType QuantConnect.Orders.OrderRequest.OrderRequestType
get

Gets the type of this order request

Definition at line 29 of file OrderRequest.cs.

◆ Status

OrderRequestStatus QuantConnect.Orders.OrderRequest.Status
get

Gets the status of this request

Definition at line 37 of file OrderRequest.cs.

◆ Time

DateTime QuantConnect.Orders.OrderRequest.Time
get

Gets the UTC time the request was created

Definition at line 45 of file OrderRequest.cs.

◆ OrderId

int QuantConnect.Orders.OrderRequest.OrderId
getprotected set

Gets the order id the request acts on

Definition at line 53 of file OrderRequest.cs.

◆ Tag

string QuantConnect.Orders.OrderRequest.Tag
get

Gets a tag for this request

Definition at line 61 of file OrderRequest.cs.

◆ Response

OrderResponse QuantConnect.Orders.OrderRequest.Response
get

Gets the response for this request. If this request was never processed then this will equal OrderResponse.Unprocessed. This value is never equal to null.

Definition at line 70 of file OrderRequest.cs.


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