デジタル入出力クラス [詳解]

詳解

デジタル入出力クラス

namespace FVCL::Dio

デジタル入出力デバイスを操作する為の基本クラスです。
このクラスは抽象クラスですので、インスタンスの生成を行うには継承する必要があります。

必要条件:: ヘッダー: FVCLdio.h

FVCL::Dio::CFvDio の継承関係図

公開メンバ関数
	CFvDio ()
	コンストラクタ [詳解]

virtual	~CFvDio ()
	デストラクタ [詳解]

virtual bool	Open (INT id)=0
	デバイスのオープン [詳解]

virtual bool	Close ()=0
	デバイスのクローズ [詳解]

virtual bool	Read (UINT *bit_pattern)=0
	読み出し [詳解]

virtual bool	Write (UINT bit_pattern)=0
	書き出し [詳解]

virtual bool	ReadInterrupt (UINT *bit_pattern)=0
	割り込み入力待機 [詳解]

virtual bool	GetInterruptEdge (UINT *edge_type)=0
	割り込みエッジ設定の取得 [詳解]

virtual bool	SetInterruptEdge (UINT edge_type)=0
	割り込みエッジ設定 [詳解]

virtual bool	GetTimeout (UINT *millisecond)
	割り込みタイムアウト取得 [詳解]

virtual bool	SetTimeout (UINT millisecond)
	割り込みタイムアウト設定 [詳解]

virtual bool	Abort ()
	割り込み入力待ち解除 [詳解]

virtual bool	ReadBit (UINT bit, bool *data)
	指定bitの読み出し [詳解]

virtual bool	WriteBit (UINT bit, bool data)
	指定bitの書き出し [詳解]

virtual bool	GetWrite (UINT *bit_pattern)
	出力データの取得 [詳解]

virtual bool	GetWriteBit (UINT bit, bool *data)
	出力データの取得 [詳解]

virtual bool	GetDriverVersion (UCHAR major, UCHAR minor, UCHAR release, UCHAR build)
	ドライババージョンの取得 [詳解]

virtual INT	GetDeviceID ()
	デバイスIDを取得 [詳解]

基底クラス FVCL::CFvObject に属する継承公開メンバ関数
	CFvObject ()
	標準のコンストラクタ [詳解]

virtual	~CFvObject ()
	デストラクタ [詳解]

INT	SetErrorCode (INT err)
	エラーコードの設定 [詳解]

INT	SetErrorCode (INT err) const
	エラーコードの設定 [詳解]

INT	GetErrorCode () const
	エラーコードの取得 [詳解]

bool	SetAllocateOption (INT value)
	画像領域確保時のオプションの設定 [詳解]

INT	GetAllocateOption () const
	画像領域確保時のオプションの取得 [詳解]

void *	operator new (size_t uiSize)
	new オペレータ [詳解]

void *	operator new[] (size_t uiSize)
	new[] オペレータ [詳解]

void	operator delete (void *pvObject)
	delete オペレータ [詳解]

void	operator delete[] (void *pvObject)
	delete[] オペレータ [詳解]

void *	operator new (size_t uiSize, LPCSTR szFileName, INT iLine)
	new オペレータ [詳解]

void *	operator new[] (size_t uiSize, LPCSTR szFileName, INT iLine)
	new[] オペレータ [詳解]

void	operator delete (void *pvObject, LPCSTR szFileName, INT iLine)
	delete オペレータ [詳解]

void	operator delete[] (void *pvObject, LPCSTR szFileName, INT iLine)
	delete[] オペレータ [詳解]

virtual CFvObject &	operator= (const CFvObject &src)
	代入オペレータ [詳解]

virtual bool	operator== (const CFvObject &src) const
	比較オペレータ (==) [詳解]

virtual bool	operator!= (const CFvObject &src) const
	比較オペレータ (!=) [詳解]

限定公開メンバ関数
virtual INT	fnConvErrCode (INT nErr)
	エラーコード変換 [詳解]

基底クラス FVCL::CFvObject に属する継承限定公開メンバ関数
INT	fnCPUCheck ()
	CPU情報の取得 [詳解]

その他の継承メンバ
基底クラス FVCL::CFvObject に属する継承静的公開メンバ関数
static bool	SetDefaultAllocateOption (INT value)
	既定の画像領域確保時のオプションの設定 [詳解]

static INT	GetDefaultAllocateOption ()
	既定の画像領域確保時のオプションの取得 [詳解]

基底クラス FVCL::CFvObject に属する継承限定公開変数類
INT	m_ErrorCode
	エラーコード [詳解]

INT	m_AllocateOption
	画像領域確保時のオプション [詳解]

構築子と解体子

FVCL::Dio::CFvDio::CFvDio ( )

コンストラクタ

標準のコンストラクタです。

FVCL::Dio::CFvDio::~CFvDio ( )

virtual

デストラクタ

このオブジェクトを破棄します。

関数詳解

FVCL::Dio::CFvDio::Open ( INT id )

pure virtual

デバイスのオープン

デジタル入出力デバイスをオープンし、使用可能な状態にします。

引数

[in]

id

ボードID

-1: オープン可能で最も小さいIDを持つボード
0~: ボードID

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::Close ( )

pure virtual

デバイスのクローズ

デジタル入出力デバイスをクローズします。

戻り値

true	正常
false	異常

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::Read ( UINT * bit_pattern )

pure virtual

読み出し

入力ポートの読み出しを行います。

引数

[out] bit_pattern 入力データ(下位16bit)

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::Write ( UINT bit_pattern )

pure virtual

書き出し

出力ポートにデータを出力します。

引数

[in] bit_pattern 出力データ(下位16bit)

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::ReadInterrupt ( UINT * bit_pattern )

pure virtual

割り込み入力待機

割り込みが入力されるまで待機します。

引数

[out] bit_pattern 割り込みが入ったときの入力データ

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::GetInterruptEdge ( UINT * edge_type )

pure virtual

割り込みエッジ設定の取得

ReadInterrupt() 関数の割り込みのエッジを設定を取得します。

バグ:: FVCLdio v1.1.0.0: 引数の説明が間違っていましたので、修正しました。

引数

[out] edge_type エッジ極性

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::SetInterruptEdge ( UINT edge_type )

pure virtual

割り込みエッジ設定

割り込み信号のエッジを設定します。

バグ:: FVCLdio v1.1.0.0: 引数の説明が間違っていましたので、修正しました。

引数

[in] edge_type エッジ極性

戻り値

true	正常
false	異常 GetErrorCodeメソッドによりエラーコードを取得できます。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で実装されています。

FVCL::Dio::CFvDio::GetTimeout ( UINT * millisecond )

virtual

割り込みタイムアウト取得

入力割り込みタイムアウトを取得します。

バージョン: FVCLdio v1.1.0.0: 新規追加

引数

[out] millisecond タイムアウト時間 (ミリ秒)

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::SetTimeout ( UINT millisecond )

virtual

割り込みタイムアウト設定

入力割り込みタイムアウトを設定します。

バージョン: FVCLdio v1.1.0.0: 新規追加

引数

[in] millisecond タイムアウト時間 (ミリ秒)

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::Abort ( )

virtual

割り込み入力待ち解除

入力割り込み入力待ちを解除します。

バージョン: FVCLdio v1.3.0.0: 新規追加

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::ReadBit	(	UINT	bit,
		bool *	data
	)

virtual

指定bitの読み出し

入力ポートの指定ビットのみ読み出しを行います。

バージョン: FVCLdio v1.3.0.0: 新規追加

引数

[in]	bit	読み出しビット
[out]	data	読み出したデータ。true:ON、false:OFF

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::WriteBit	(	UINT	bit,
		bool	data
	)

virtual

指定bitの書き出し

出力ポートの指定ビットのみ書き出しを行います。

バージョン: FVCLdio v1.3.0.0: 新規追加

引数

[in]	bit	書き出しビット
[in]	data	書き出すデータ。true:ON、false:OFF

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::GetWrite ( UINT * bit_pattern )

virtual

出力データの取得

出力ポートに出力されているデータを取得します。

バージョン: FVCLdio v1.3.0.0: 新規追加

引数

[out] bit_pattern 出力されているデータ

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::GetWriteBit	(	UINT	bit,
		bool *	data
	)

virtual

出力データの取得

出力ポートに出力されているデータを取得します。

バージョン: FVCLdio v1.3.0.0: 新規追加

引数

[in]	bit	取得ビット
[out]	data	取得したデータ。true:ON、false:OFF

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::GetDriverVersion	(	UCHAR *	major,
		UCHAR *	minor,
		UCHAR *	release,
		UCHAR *	build
	)

virtual

ドライババージョンの取得

ドライババージョンを取得します。

バージョン: FVCLdio v1.3.0.0: 新規追加

引数

[out]	major	メジャーバージョン
[out]	minor	マイナーバージョン
[out]	release	リリースバージョン
[out]	build	ビルドバージョン

戻り値

true	正常
false	異常 GetErrorCode メソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::GetDeviceID ( )

virtual

デバイスIDを取得

オープンしたボードのデバイスID (ボードID)を取得します。

バージョン: FVCLdio v1.3.0.0: 新規追加

戻り値

0~15	デバイスID(ボードID)
-1	エラー GetErrorCodeメソッドによりエラーコードを取得できます。

エラーコード:

値	定数	内容
21	FVCL_ErrorCode::NOT_SUPPORTED	サポートされていません。

解説:: これは純粋仮想関数です。実際の処理は継承したクラスで実装されます。派生クラスが、この関数をオーバーライドしなかった場合は、常に false を返し、エラーコードに FVCL_ErrorCode::NOT_SUPPORTED が設定されます。

FVCL::Dio::CFvDioFIO01, FVCL::Dio::CFvDioFV1400, FVCL::Dio::CFvDioII320, FVCL::Dio::CFvDioFV1300で再実装されています。

FVCL::Dio::CFvDio::fnConvErrCode ( INT nErr )

protectedvirtual

エラーコード変換

内部エラーコードをFVCLエラーコードへ変換して返します。

引数

[in] nErr 内部エラーコード

戻り値: FVCLエラーコードを返します。

FVCL::Dio::CFvDioFV1400で再実装されています。

詳解

公開メンバ関数

限定公開メンバ関数

その他の継承メンバ

構築子と解体子

関数詳解