クラス BPList

コントロールカーブのデータ点リストを表すクラス


コンストラクタの概要
static  BPList new(void ...,string name,int defaultValue,int minimum,int maximum)
          初期化を行う
 
メソッドの概要
 int add(int clock,int value)
          データ点を追加する。
 int addWithId(int clock,int value,int id)
          データ点を、ID 指定したうえで追加する。
 void addWithoutSort(int clock,int value)
          並べ替え、既存の値との重複チェックを行わず、リストの末尾にデータ点を追加する
 void clear()
          全てのデータ点を削除する
 BPList clone()
          コピーを作成する
 BPListSearchResult findElement(int id)
          ID を基にデータ点を検索し、検索結果を取得する
 int findValueFromId(int id)
          ID を基にデータ点の値を取得する
 BP get(int index)
          データ点を取得する
 int getDefault()
          コントロールカーブのデフォルト値を取得する
 int getKeyClock(int index)
          データ点の時刻を取得する
 int getMaxId()
          このリスト内で使用されている ID の最大値を取得する
 int getMaximum()
          コントロールカーブの最大値を取得する
 int getMinimum()
          コントロールカーブの最小値を取得する
 string getName()
          コントロールカーブの名前を取得する
 int getValue(int index)
          データ点の値を取得する
 int getValueAt(int clock)
          指定された Tick 単位の時刻における,コントロールパラメータの値を取得する.
 int getValueAt(int clock,table index)
          指定された Tick 単位の時刻における、コントロールパラメータの値を取得する
 boolean isContainsKey(int clock)
          指定された時刻にデータ点が存在するかどうかを調べる
 BPList.KeyClockIterator keyClockIterator()
          データ点の Tick 単位の時刻を昇順に返す反復子を取得する
 void print(TextStream stream,int startClock,string header)
          コントロールカーブをテキストストリームに出力する
 void setDefault(int value)
          コントロールカーブのデフォルト値を設定する
 void setMaximum(int value)
          コントロールカーブの最大値を設定する
 void setMinimum(int value)
          コントロールカーブの最小値を設定する
 void setName(string value)
          コントロールカーブの名前を設定する
 void setValueForId(int id,int value)
          指定した ID のデータ点の値を設定する
 int size()
          データ点の個数を返す
 
コンストラクタの詳細

new

public static BPList new(void ...,
                         string name,
                         int defaultValue,
                         int minimum,
                         int maximum)

初期化を行う

パラメータ:
... -
name - コントロールカーブの名前
defaultValue - コントロールカーブのデフォルト値
minimum - コントロールカーブの最小値
maximum - コントロールカーブの最大値
戻り値:
メソッドの詳細

add

public int add(int clock,
               int value)

データ点を追加する。指定された時刻に既にデータ点がある場合、データ点の値を上書きする

パラメータ:
clock - データ点を追加する Tick 単位の時刻
value - データ点の値
戻り値:
データ点の ID

addWithId

public int addWithId(int clock,
                     int value,
                     int id)

データ点を、ID 指定したうえで追加する。指定された時刻に既にデータ点がある場合、データ点の値を上書きする

パラメータ:
clock - データ点を追加する Tick 単位の時刻
value - データ点の値
id - データ点の ID
戻り値:
データ点の ID

addWithoutSort

public void addWithoutSort(int clock,
                           int value)

並べ替え、既存の値との重複チェックを行わず、リストの末尾にデータ点を追加する

パラメータ:
clock - Tick 単位の時刻
value - データ点の値

clear

public void clear()

全てのデータ点を削除する


clone

public BPList clone()

コピーを作成する

戻り値:
このオブジェクトのコピー

findElement

public BPListSearchResult findElement(int id)

ID を基にデータ点を検索し、検索結果を取得する

パラメータ:
id - データ点の ID
戻り値:
検索結果を格納したオブジェクト

findValueFromId

public int findValueFromId(int id)

ID を基にデータ点の値を取得する

パラメータ:
id - データ点の ID
戻り値:
データ点の値

get

public BP get(int index)

データ点を取得する

パラメータ:
index - 取得するデータ点のインデックス(最初のインデックスは0)
戻り値:
データ点のインスタンス

getDefault

public int getDefault()

コントロールカーブのデフォルト値を取得する

戻り値:
コントロールカーブのデフォルト値

getKeyClock

public int getKeyClock(int index)

データ点の時刻を取得する

パラメータ:
index - 取得するデータ点のインデックス(最初のインデックスは0)
戻り値:
データ点の Tick 単位の時刻

getMaxId

public int getMaxId()

このリスト内で使用されている ID の最大値を取得する

戻り値:
使用されている ID の最大値

getMaximum

public int getMaximum()

コントロールカーブの最大値を取得する

戻り値:
コントロールカーブの最大値

getMinimum

public int getMinimum()

コントロールカーブの最小値を取得する

戻り値:
コントロールカーブの最小値

getName

public string getName()

コントロールカーブの名前を取得する

戻り値:
コントロールカーブの名前

getValue

public int getValue(int index)

データ点の値を取得する

パラメータ:
index - 取得するデータ点のインデックス(最初のインデックスは0)
戻り値:
データ点の値

getValueAt

public int getValueAt(int clock)

指定された Tick 単位の時刻における,コントロールパラメータの値を取得する.

パラメータ:
clock - 値を取得する Tick 単位の時刻
戻り値:
コントロールパラメータの値

getValueAt

public int getValueAt(int clock,
                      table index)

指定された Tick 単位の時刻における、コントロールパラメータの値を取得する

パラメータ:
clock - 値を取得する Tick 単位の時刻
index - 値の取得に使用したインデックス(最初のインデックスは0)
戻り値:
コントロールパラメータの値

isContainsKey

public boolean isContainsKey(int clock)

指定された時刻にデータ点が存在するかどうかを調べる

パラメータ:
clock - Tick 単位の時刻
戻り値:
データ点が存在すれば ture を、そうでなければ false を返す

keyClockIterator

public BPList.KeyClockIterator keyClockIterator()

データ点の Tick 単位の時刻を昇順に返す反復子を取得する

戻り値:
反復子のインスタンス

print

public void print(TextStream stream,
                  int startClock,
                  string header)

コントロールカーブをテキストストリームに出力する

パラメータ:
stream - 出力先のストリーム
startClock - Tick 単位の出力開始時刻
header - 最初に出力するヘッダー文字列

setDefault

public void setDefault(int value)

コントロールカーブのデフォルト値を設定する

パラメータ:
value - コントロールカーブのデフォルト値

setMaximum

public void setMaximum(int value)

コントロールカーブの最大値を設定する

パラメータ:
value - コントロールカーブの最大値

setMinimum

public void setMinimum(int value)

コントロールカーブの最小値を設定する

パラメータ:
value - コントロールカーブの最小値

setName

public void setName(string value)

コントロールカーブの名前を設定する

パラメータ:
value - コントロールカーブの名前

setValueForId

public void setValueForId(int id,
                          int value)

指定した ID のデータ点の値を設定する

パラメータ:
id - データ点の ID
value - 設定するデータ点の値

size

public int size()

データ点の個数を返す

戻り値:
データ点の個数