AM Daemon ライブラリリファレンス
公開メンバ関数 | 全メンバ一覧

JVSの入出力処理を提供するMonostateクラス。 [詳解]

#include <Jvs.h>

公開メンバ関数

bool isAvailable () const
 JVSの入出力機能を利用可能であるか否かを取得する。 [詳解]
 
std::size_t getNodeCount () const
 ノード数(JVSボード数)を取得する。 [詳解]
 
JvsNodegetNode (std::size_t nodeIndex)
 ノード操作インスタンスを取得する。 [詳解]
 
const JvsNodegetNode (std::size_t nodeIndex) const
 ノード操作インスタンスを取得する。 [詳解]
 
std::vector< std::reference_wrapper< JvsNode > > getNodes ()
 ノード操作インスタンス配列を取得する。 [詳解]
 
std::vector< std::reference_wrapper< const JvsNode > > getNodes () const
 ノード操作インスタンス配列を取得する。 [詳解]
 

詳解

JVSの入出力処理を提供するMonostateクラス。

参照
Input, Output

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。

JVSの生入力値を取得したり直接出力を行いたい場合に用いる。 ID付けされた入出力処理を行う場合はこのクラスではなく Input クラスや Output クラスを用いること。

Output クラスとは出力値を共有しており、 どちらか一方で設定した出力値はもう一方にも反映される。

プラットフォーム情報
  • ALLSシリーズではJVS機能は利用できない。
  • ALLSシリーズの場合、常にノード数(JVSボード数) 0 として扱われる。

関数詳解

bool amdaemon::Jvs::isAvailable ( ) const
inline

JVSの入出力機能を利用可能であるか否かを取得する。

戻り値
true利用可能である場合。
false機能が無効である場合。

条件式 (getNodeCount() > 0) の結果を返す。

std::size_t amdaemon::Jvs::getNodeCount ( ) const

ノード数(JVSボード数)を取得する。

戻り値
ノード数(JVSボード数)。
JvsNode& amdaemon::Jvs::getNode ( std::size_t  nodeIndex)

ノード操作インスタンスを取得する。

引数
[in]nodeIndexノードインデックス。Node1 が 0 、Node2 が 1 のように対応する。
戻り値
ノード操作インスタンス。
例外
Exception引数 nodeIndex にノード数以上の値を指定した場合。 ノード数はメンバ関数 getNodeCount で取得できる。
const JvsNode& amdaemon::Jvs::getNode ( std::size_t  nodeIndex) const

ノード操作インスタンスを取得する。

引数
[in]nodeIndexノードインデックス。Node1 が 0 、Node2 が 1 のように対応する。
戻り値
ノード操作インスタンス。
例外
Exception引数 nodeIndex にノード数以上の値を指定した場合。 ノード数はメンバ関数 getNodeCount で取得できる。
std::vector<std::reference_wrapper<JvsNode> > amdaemon::Jvs::getNodes ( )
inline

ノード操作インスタンス配列を取得する。

戻り値
ノード操作インスタンス配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

  • ノード数を知りたいだけならばメンバ関数 getNodeCount を用いること。
  • 特定ノードを取得したいだけならばメンバ関数 getNode を用いること。
std::vector<std::reference_wrapper<const JvsNode> > amdaemon::Jvs::getNodes ( ) const
inline

ノード操作インスタンス配列を取得する。

戻り値
ノード操作インスタンス配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

  • ノード数を知りたいだけならばメンバ関数 getNodeCount を用いること。
  • 特定ノードを取得したいだけならばメンバ関数 getNode を用いること。

このクラス詳解は次のファイルから抽出されました: