Lean  $LEAN_TAG$
QuantConnect.Python.DividendYieldModelPythonWrapper Class Reference

Wraps a PyObject object that represents a dividend yield model More...

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

Public Member Functions

 DividendYieldModelPythonWrapper (PyObject model)
 Constructor for initializing the DividendYieldModelPythonWrapper class with wrapped PyObject object More...
 
decimal GetDividendYield (DateTime date)
 Get dividend yield by a given date of a given symbol More...
 
decimal GetDividendYield (DateTime date, decimal securityPrice)
 Get dividend yield at given date and security price More...
 
- Public Member Functions inherited from QuantConnect.Python.BasePythonWrapper< IDividendYieldModel >
 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...
 

Static Public Member Functions

static IDividendYieldModel FromPyObject (PyObject model)
 Converts a PyObject object into a IDividendYieldModel object, wrapping it if necessary More...
 

Additional Inherited Members

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

Detailed Description

Wraps a PyObject object that represents a dividend yield model

Definition at line 25 of file DividendYieldModelPythonWrapper.cs.

Constructor & Destructor Documentation

◆ DividendYieldModelPythonWrapper()

QuantConnect.Python.DividendYieldModelPythonWrapper.DividendYieldModelPythonWrapper ( PyObject  model)

Constructor for initializing the DividendYieldModelPythonWrapper class with wrapped PyObject object

Parameters
modelRepresents a security's model of dividend yield

Definition at line 31 of file DividendYieldModelPythonWrapper.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ GetDividendYield() [1/2]

decimal QuantConnect.Python.DividendYieldModelPythonWrapper.GetDividendYield ( DateTime  date)

Get dividend yield by a given date of a given symbol

Parameters
dateThe date
Returns
Dividend yield on the given date of the given symbol

Implements QuantConnect.Data.IDividendYieldModel.

Definition at line 41 of file DividendYieldModelPythonWrapper.cs.

Here is the caller graph for this function:

◆ GetDividendYield() [2/2]

decimal QuantConnect.Python.DividendYieldModelPythonWrapper.GetDividendYield ( DateTime  date,
decimal  securityPrice 
)

Get dividend yield at given date and security price

Parameters
dateThe date
securityPriceThe security price at the given date
Returns
Dividend yield on the given date of the given symbol

Price data must be raw (DataNormalizationMode.Raw)

Implements QuantConnect.Data.IDividendYieldModel.

Definition at line 53 of file DividendYieldModelPythonWrapper.cs.

Here is the call graph for this function:

◆ FromPyObject()

static IDividendYieldModel QuantConnect.Python.DividendYieldModelPythonWrapper.FromPyObject ( PyObject  model)
static

Converts a PyObject object into a IDividendYieldModel object, wrapping it if necessary

Parameters
modelThe Python model
Returns
The converted IDividendYieldModel instance

Definition at line 63 of file DividendYieldModelPythonWrapper.cs.

Here is the call graph for this function:

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