hal::counter::PulseWidth 結構 參考文件

[Interface] 脈寬計數器介面定義 更多...

#include <PulseWidth.h>

類別hal::counter::PulseWidth的繼承圖:

公開方法(Public Methods)
virtual int	setPeriod (float hz) override
	設定計數器週期
virtual bool	setPercent (int channel, float percent) override
	設定指定通道的脈寬百分比
virtual bool	getPercent (int channel, float &result) override
	取得指定通道的脈寬百分比
virtual bool	start (bool enable) override
	啟動或停止計數器
公開方法(Public Methods) 繼承自 hal::Base
virtual bool	deinit (void) override
	硬體去初始化。
virtual bool	init (void) override
	硬體初始化。
virtual bool	isInit (void) override
	取得硬體是否已初始化。
公開方法(Public Methods) 繼承自 mframe::lang::Interface
virtual	~Interface (void)=default
	Destroy the struct object.
virtual mframe::lang::Object &	getObject (void) override
	取得類Object

詳細描述

[Interface] 脈寬計數器介面定義

提供設定週期、調整各通道脈寬百分比以及啟動計數器的方法， 供硬體抽象層相關模組調用。

函式成員說明文件

getPercent()

virtual bool hal::counter::PulseWidth::getPercent ( int channel, float & result )

pure virtual

取得指定通道的脈寬百分比

參數

channel	通道編號
result	傳出參數，存放取得的脈寬百分比

傳回值

bool true: 取得成功; false: 取得失敗。

實作於 core::CorePulseWidth.

setPercent()

virtual bool hal::counter::PulseWidth::setPercent ( int channel, float percent )

pure virtual

設定指定通道的脈寬百分比

參數

channel	通道編號
percent	脈寬百分比 (0 ~ 1)

傳回值

bool true: 設定成功; false: 設定失敗。

實作於 core::CorePulseWidth.

setPeriod()

virtual int hal::counter::PulseWidth::setPeriod ( float hz )

pure virtual

設定計數器週期

參數

hz

輸入頻率 (Hz)

傳回值

int 回傳結果，數值定義依具體實作而定

實作於 core::CorePulseWidth.

start()

virtual bool hal::counter::PulseWidth::start ( bool enable )

pure virtual

啟動或停止計數器

參數

enable

true: 啟動計數器; false: 停止計數器。

傳回值

bool true: 操作成功; false: 操作失敗。

實作於 core::CorePulseWidth.

---

此結構(structure) 文件是由下列檔案中產生:

• PulseWidth.h