hikyuu2/libs/hikyuu/data_driver/KDataDriver.h

/*
 * KDataDriver.h
 *
 *  Created on: 2012-9-8
 *      Author: fasiondog
 */

#ifndef KDATADRIVER_H_
#define KDATADRIVER_H_

#include "../utilities/Parameter.h"
#include "KDataDriverImp.h"

namespace hku {

/**
 * K线数据驱动基类
 */
class HKU_API KDataDriver {
    PARAMETER_SUPPORT

public:
    KDataDriver();
    KDataDriver(const string& name);
    virtual ~KDataDriver() { }

    const string& name() const;

    bool init(const Parameter&);

    /**
     * 子类初始化私有变量接口
     * @return
     */
    virtual bool _init() {
        return true;
    }


    /**
     * 将指定类型的K线数据加载至缓存
     * @param market 市场简称
     * @param code   证券代码
     * @param kType  K线类型
     * @param start_ix 欲加载的起始位置
     * @param end_ix 欲加载的结束位置，不包含自身
     * @param out_buffer [out] 缓存指针
     */
    virtual void loadKData(const string& market, const string& code,
            KQuery::KType kType, size_t start_ix, size_t end_ix,
            KRecordList* out_buffer) ;

    /**
     * 获取指定类型的K线数据量
     * @param market 市场简称
     * @param code   证券代码
     * @param kType  K线类型
     * @return
     */
    virtual size_t getCount(const string& market, const string& code,
            KQuery::KType kType);

    /**
     * 获取指定日期范围对应的K线记录索引
     * @param market 市场简称
     * @param code   证券代码
     * @param query  查询条件
     * @param out_start [out] 对应K线记录位置
     * @param out_end [out] 对应的K线记录位置
     * @return
     */
    virtual bool getIndexRangeByDate(const string& market, const string& code,
            const KQuery& query, size_t& out_start, size_t& out_end);

    /**
     * 获取指定的K线记录
     * @param market 市场简称
     * @param code   证券代码
     * @param pos    K线记录索引
     * @param kType  K线类型
     * @return
     */
    virtual KRecord getKRecord(const string& market, const string& code,
              size_t pos, KQuery::KType kType);

private:
    bool checkType();

private:
    string m_name;
};


typedef shared_ptr<KDataDriver> KDataDriverPtr;


inline const string& KDataDriver::name() const {
    return m_name;
}

} /* namespace */

#endif /* KDATADRIVER_H_ */