QuantConnect.Python.DividendYieldModelPythonWrapper Class Reference
Wraps a PyObject object that represents a dividend yield model More...
Inheritance diagram for QuantConnect.Python.DividendYieldModelPythonWrapper:
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... | |
 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... | |
| T | 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... | |
| T | 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... | |
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
-
model Represents 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()
| decimal QuantConnect.Python.DividendYieldModelPythonWrapper.GetDividendYield | ( | DateTime | date | ) |
Get dividend yield by a given date of a given symbol
- Parameters
-
date The date
- Returns
- Dividend yield on the given date of the given symbol
Implements QuantConnect.Data.IDividendYieldModel.
Definition at line 41 of file DividendYieldModelPythonWrapper.cs.
◆ FromPyObject()
|
static |
Converts a PyObject object into a IDividendYieldModel object, wrapping it if necessary
- Parameters
-
model The Python model
- Returns
- The converted IDividendYieldModel instance
Definition at line 51 of file DividendYieldModelPythonWrapper.cs.
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Common/Python/DividendYieldModelPythonWrapper.cs
