hikyuu2/docs/source/indicator/ind_class.rst
2023-12-30 14:25:48 +08:00

152 lines
3.2 KiB
ReStructuredText

.. py:currentmodule:: hikyuu.indicator
.. highlight:: python
Indicator
============
.. py:class:: Indicator(name)
Indicator 指标定义
.. py:attribute:: name 名称
.. py:attribute:: long_name 名称
.. py:attribute:: discard 需抛弃的点数
.. py:method:: have_param(self, name)
是否存在指定参数
:param str name: 参数名称
.. py:method:: get_param(self, name)
获取指定的参数
:param str name: 参数名称
:return: 参数值
:raises out_of_range: 无此参数
.. py:method:: set_param(self, name, value)
设置参数
:param str name: 参数名称
:param value: 参数值
:type value: int | bool | float | string
:raises logic_error: Unsupported type! 不支持的参数类型
.. py:method:: support_ind_param(self)
是否支持动态指标参数
.. py:method:: have_ind_param(self, name)
是否存在指定参数
:param str name: 参数名称
.. py:method:: get_ind_param(self, name)
获取指定的动态指标参数
:param str name: 参数名称
:rtype: IndParam
.. py::method:: set_ind_param(self, name, val)
设置动态指标参数
:param str name: 参数名称
:param Indicator|IndParam: 参数值(可为 Indicator 或 IndParam 实例)
.. py:method:: clone(self)
克隆操作
.. py:method:: empty(self)
是否为空
:rtype: bool
.. py:method:: formula(self)
打印指标公式
:rtype: str
.. py:method:: get_result_num(self)
获取结果集数量
:rtype: int
.. py:method:: get(self, result_index[, num=0])
获取指定位置的值
:param int pos: 指定的位置索引
:param int num: 指定的结果集
.. py::method:: get_pos(self, date):
获取指定日期相应的索引位置
:param Datetime date: 指定日期
:rtype: int
.. py:method:: get_datetime(self, pos)
获取指定位置的日期
:param int pos: 指定的位置索引
.. py:method:: get_by_datetime(self, datetime[, result_index=0])
获取指定日期数值。如果对应日期无结果,返回 constant.null_price
:param Datetime datetime: 指定日期
:param int num: 指定的结果集
:rtype: float
.. py:method:: get_result(self, result_index)
获取指定结果集
:param int result_index: 指定的结果集
:rtype: Indicator
.. py:method:: get_result_as_price_list(self, result_index)
获取指定结果集
:param int result_index: 指定的结果集
:rtype: list
.. py:method:: get_datetime_list(self)
返回对应的日期列表
:rtype: DatetimeList
.. py:method:: get_context(self)
获取上下文
:rtype: KData
.. py:method:: set_context(self, kdata)
设置上下文
:param KData kdata: 关联的上下文K线
set_context(self, stock, query)
设置上下文
:param Stock stock: 指定的 Stock
:param Query query: 指定的查询条件