Lean  $LEAN_TAG$
QuantConnect.Brokerages.Paper.PaperBrokerageFactory Class Reference

The factory type for the PaperBrokerage More...

Inheritance diagram for QuantConnect.Brokerages.Paper.PaperBrokerageFactory:
[legend]

Public Member Functions

override IBrokerageModel GetBrokerageModel (IOrderProvider orderProvider)
 Gets a new instance of the InteractiveBrokersBrokerageModel More...
 
override IBrokerage CreateBrokerage (LiveNodePacket job, IAlgorithm algorithm)
 Creates a new IBrokerage instance More...
 
override void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
 PaperBrokerageFactory ()
 Initializes a new instance of the PaperBrokerageFactory class More...
 
- Public Member Functions inherited from QuantConnect.Brokerages.BrokerageFactory
virtual IBrokerageMessageHandler CreateBrokerageMessageHandler (IAlgorithm algorithm, AlgorithmNodePacket job, IApi api)
 Gets a brokerage message handler More...
 

Public Attributes

override Dictionary< string, string > BrokerageData => new Dictionary<string
 Gets the brokerage data required to run the IB brokerage from configuration More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Brokerages.BrokerageFactory
 BrokerageFactory (Type brokerageType)
 Initializes a new instance of the BrokerageFactory class for the specified brokerageType More...
 
- Static Protected Member Functions inherited from QuantConnect.Brokerages.BrokerageFactory
static T Read< T > (IReadOnlyDictionary< string, string > brokerageData, string key, ICollection< string > errors)
 Reads a value from the brokerage data, adding an error if the key is not found More...
 
- Properties inherited from QuantConnect.Brokerages.BrokerageFactory
Type BrokerageType [get]
 Gets the type of brokerage produced by this factory More...
 
abstract Dictionary< string, string > BrokerageData [get]
 Gets the brokerage data required to run the brokerage from configuration/disk More...
 
- Properties inherited from QuantConnect.Interfaces.IBrokerageFactory
Type BrokerageType [get]
 Gets the type of brokerage produced by this factory More...
 
Dictionary< string, string > BrokerageData [get]
 Gets the brokerage data required to run the brokerage from configuration/disk More...
 

Detailed Description

The factory type for the PaperBrokerage

Definition at line 27 of file PaperBrokerageFactory.cs.

Constructor & Destructor Documentation

◆ PaperBrokerageFactory()

QuantConnect.Brokerages.Paper.PaperBrokerageFactory.PaperBrokerageFactory ( )

Initializes a new instance of the PaperBrokerageFactory class

Definition at line 71 of file PaperBrokerageFactory.cs.

Member Function Documentation

◆ GetBrokerageModel()

override IBrokerageModel QuantConnect.Brokerages.Paper.PaperBrokerageFactory.GetBrokerageModel ( IOrderProvider  orderProvider)
virtual

Gets a new instance of the InteractiveBrokersBrokerageModel

Parameters
orderProviderThe order provider

Implements QuantConnect.Brokerages.BrokerageFactory.

◆ CreateBrokerage()

override IBrokerage QuantConnect.Brokerages.Paper.PaperBrokerageFactory.CreateBrokerage ( LiveNodePacket  job,
IAlgorithm  algorithm 
)
virtual

Creates a new IBrokerage instance

Parameters
jobThe job packet to create the brokerage for
algorithmThe algorithm instance
Returns
A new brokerage instance

Implements QuantConnect.Brokerages.BrokerageFactory.

Definition at line 54 of file PaperBrokerageFactory.cs.

◆ Dispose()

override void QuantConnect.Brokerages.Paper.PaperBrokerageFactory.Dispose ( )
virtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

<filterpriority>2</filterpriority>

Implements QuantConnect.Brokerages.BrokerageFactory.

Definition at line 63 of file PaperBrokerageFactory.cs.

Member Data Documentation

◆ BrokerageData

override Dictionary<string, string> QuantConnect.Brokerages.Paper.PaperBrokerageFactory.BrokerageData => new Dictionary<string

Gets the brokerage data required to run the IB brokerage from configuration

The implementation of this property will create the brokerage data dictionary required for running live jobs. See IJobQueueHandler.NextJob

Definition at line 36 of file PaperBrokerageFactory.cs.


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