getCycleCount( )

現在のサブジェクトの入力ブランチ内のサブジェクトごとの現在のサイクル・インスタンス番号を取得します。たとえば、既存のサイクルの数を取得できます。

構文

getCycleCount(branchShortName)

パラメータ

パラメータ 必須/オプション 説明
branchShortName 必須

クエリーするブランチの短縮ID。

戻り値

分岐サイクルを示す番号:
  • 正の数値は、現在のサイクル番号を示します。
  • -1サブジェクトが指定されたブランチに存在しない場合。

使用上のヒント

調査バージョン間でブランチ名を変更する場合は、isStudyVersion( )関数を使用して適切な名前を取得します。

例)

例3-99 Branch01に少なくとも1つの開始サイクルがある場合、ドロップダウンの値をtrueに設定します

// get the current cycle count of branch 'Branch01'
var cycleCount = getCycleCount('Branch01');
  
// if at least 1 cycle has been started in Branch01, set value to true
if (cycleCount > 1) {
  return setChoiceLabel("TRUE");
} else {
  return setChoiceLabel("FALSE");
}