Lean  $LEAN_TAG$
QuantConnect.Python.SlippageModelPythonWrapper Class Reference

Wraps a PyObject object that represents a model that simulates market order slippage More...

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

Public Member Functions

 SlippageModelPythonWrapper (PyObject model)
 Constructor for initialising the SlippageModelPythonWrapper class with wrapped PyObject object More...
 
decimal GetSlippageApproximation (Security asset, Order order)
 Slippage Model. Return a decimal cash slippage approximation on the order. More...
 
- Public Member Functions inherited from QuantConnect.Python.BasePythonWrapper< ISlippageModel >
 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< ISlippageModel >
PyObject Instance
 Gets the underlying python instance More...
 

Detailed Description

Wraps a PyObject object that represents a model that simulates market order slippage

Definition at line 26 of file SlippageModelPythonWrapper.cs.

Constructor & Destructor Documentation

◆ SlippageModelPythonWrapper()

QuantConnect.Python.SlippageModelPythonWrapper.SlippageModelPythonWrapper ( PyObject  model)

Constructor for initialising the SlippageModelPythonWrapper class with wrapped PyObject object

Parameters
modelRepresents a model that simulates market order slippage

Definition at line 32 of file SlippageModelPythonWrapper.cs.

Member Function Documentation

◆ GetSlippageApproximation()

decimal QuantConnect.Python.SlippageModelPythonWrapper.GetSlippageApproximation ( Security  asset,
Order  order 
)

Slippage Model. Return a decimal cash slippage approximation on the order.

Parameters
assetThe security matching the order
orderThe order to compute slippage for
Returns
The slippage of the order in units of the account currency

Implements QuantConnect.Orders.Slippage.ISlippageModel.

Definition at line 43 of file SlippageModelPythonWrapper.cs.


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