Lean  $LEAN_TAG$
QuantConnect.Python.BenchmarkPythonWrapper Class Reference

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

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

Public Member Functions

 BenchmarkPythonWrapper (PyObject model)
 Constructor for initialising the BenchmarkPythonWrapper class with wrapped PyObject object More...
 
decimal Evaluate (DateTime time)
 Evaluates this benchmark at the specified time using the method defined in the Python class More...
 
- Public Member Functions inherited from QuantConnect.Python.BasePythonWrapper< IBenchmark >
 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< IBenchmark >
PyObject Instance
 Gets the underlying python instance More...
 

Detailed Description

Provides an implementation of IBenchmark that wraps a PyObject object

Definition at line 25 of file BenchmarkPythonWrapper.cs.

Constructor & Destructor Documentation

◆ BenchmarkPythonWrapper()

QuantConnect.Python.BenchmarkPythonWrapper.BenchmarkPythonWrapper ( PyObject  model)

Constructor for initialising the BenchmarkPythonWrapper class with wrapped PyObject object

Parameters
modelPython benchmark model

Definition at line 31 of file BenchmarkPythonWrapper.cs.

Member Function Documentation

◆ Evaluate()

decimal QuantConnect.Python.BenchmarkPythonWrapper.Evaluate ( DateTime  time)

Evaluates this benchmark at the specified time using the method defined in the Python class

Parameters
timeThe time to evaluate the benchmark at
Returns
The value of the benchmark at the specified time

Implements QuantConnect.Benchmarks.IBenchmark.

Definition at line 41 of file BenchmarkPythonWrapper.cs.


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