Lean  $LEAN_TAG$
QuantConnect.Python.SettlementModelPythonWrapper Class Reference

Provides an implementation of ISettlementModel that wraps a PyObject object More...

Inheritance diagram for QuantConnect.Python.SettlementModelPythonWrapper:
[legend]

Public Member Functions

 SettlementModelPythonWrapper (PyObject model)
 Constructor for initialising the SettlementModelPythonWrapper class with wrapped PyObject object More...
 
void ApplyFunds (ApplyFundsSettlementModelParameters applyFundsParameters)
 Applies cash settlement rules using the method defined in the Python class More...
 
void Scan (ScanSettlementModelParameters settlementParameters)
 Scan for pending settlements using the method defined in the Python class More...
 
CashAmount GetUnsettledCash ()
 Gets the unsettled cash amount for the security More...
 
- Public Member Functions inherited from QuantConnect.Python.BasePythonWrapper< ISettlementModel >
 BasePythonWrapper (bool validateInterface=true)
 Creates a new instance of the BasePythonWrapper<TInterface> class More...
 
 BasePythonWrapper (PyObject instance, bool validateInterface=true)
 Creates a new instance of the BasePythonWrapper<TInterface> class with the specified instance More...
 
void SetPythonInstance (PyObject instance)
 Sets the python instance More...
 
GetProperty< T > (string propertyName)
 Gets the Python instance property with the specified name More...
 
PyObject GetProperty (string propertyName)
 Gets the Python instance property with the specified name More...
 
void SetProperty (string propertyName, object value)
 Sets the Python instance property with the specified name More...
 
dynamic GetEvent (string name)
 Gets the Python instance event with the specified name More...
 
bool HasAttr (string name)
 Determines whether the Python instance has the specified attribute More...
 
PyObject GetMethod (string methodName)
 Gets the Python instances method with the specified name and caches it More...
 
InvokeMethod< T > (string methodName, params object[] args)
 Invokes the specified method with the specified arguments More...
 
PyObject InvokeMethod (string methodName, params object[] args)
 Invokes the specified method with the specified arguments More...
 
void InvokeVoidMethod (string methodName, params object[] args)
 Invokes the specified method with the specified arguments without returning a value More...
 
IEnumerable< T > InvokeMethodAndEnumerate< T > (string methodName, params object[] args)
 Invokes the specified method with the specified arguments and iterates over the returned values More...
 
Dictionary< TKey, TValue > InvokeMethodAndGetDictionary< TKey, TValue > (string methodName, params object[] args)
 Invokes the specified method with the specified arguments and iterates over the returned values More...
 
InvokeMethodWithOutParameters< T > (string methodName, Type[] outParametersTypes, out object[] outParameters, params object[] args)
 Invokes the specified method with the specified arguments and out parameters More...
 
InvokeMethodAndWrapResult< T > (string methodName, Func< PyObject, T > wrapResult, params object[] args)
 Invokes the specified method with the specified arguments and wraps the result by calling the given function if the result is not a C# object More...
 
virtual bool Equals (BasePythonWrapper< TInterface > other)
 Determines whether the specified instance wraps the same Python object reference as this instance, which would indicate that they are equal. More...
 
override bool Equals (object obj)
 Determines whether the specified object is an instance of BasePythonWrapper<TInterface> and wraps the same Python object reference as this instance, which would indicate that they are equal. More...
 
override int GetHashCode ()
 Gets the hash code for the current instance More...
 

Additional Inherited Members

- Protected Attributes inherited from QuantConnect.Python.BasePythonWrapper< ISettlementModel >
PyObject Instance
 Gets the underlying python instance More...
 

Detailed Description

Provides an implementation of ISettlementModel that wraps a PyObject object

Definition at line 25 of file SettlementModelPythonWrapper.cs.

Constructor & Destructor Documentation

◆ SettlementModelPythonWrapper()

QuantConnect.Python.SettlementModelPythonWrapper.SettlementModelPythonWrapper ( PyObject  model)

Constructor for initialising the SettlementModelPythonWrapper class with wrapped PyObject object

Parameters
modelSettlement Python Model

Definition at line 31 of file SettlementModelPythonWrapper.cs.

Member Function Documentation

◆ ApplyFunds()

void QuantConnect.Python.SettlementModelPythonWrapper.ApplyFunds ( ApplyFundsSettlementModelParameters  applyFundsParameters)

Applies cash settlement rules using the method defined in the Python class

Parameters
applyFundsParametersThe funds application parameters

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 40 of file SettlementModelPythonWrapper.cs.

Here is the call graph for this function:

◆ Scan()

void QuantConnect.Python.SettlementModelPythonWrapper.Scan ( ScanSettlementModelParameters  settlementParameters)

Scan for pending settlements using the method defined in the Python class

Parameters
settlementParametersThe settlement parameters

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 49 of file SettlementModelPythonWrapper.cs.

Here is the call graph for this function:

◆ GetUnsettledCash()

CashAmount QuantConnect.Python.SettlementModelPythonWrapper.GetUnsettledCash ( )

Gets the unsettled cash amount for the security

Implements QuantConnect.Securities.ISettlementModel.

Definition at line 57 of file SettlementModelPythonWrapper.cs.


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