info.bix.tokai.bixpp.binding
クラス VectorItem

java.lang.Object
  info.bix.tokai.bixpp.binding.DefinitionItem
      info.bix.tokai.bixpp.binding.VectorItem

すべての実装されたインタフェース:

java.io.Serializable

public class VectorItem
extends DefinitionItem
implements java.io.Serializable

RecordingDefinition内に定義する情報のうち、 多次元配列情報を定義するクラスです。その他に定義できる情報として、ImageItem、 DataItem、EventItem、SoundItem があります。このクラスは、Index、名前、多次元配列の次元数、多次元配列の持つ数値データの定義 で構成されています。

VectorItemオブジェクトは、１つの多次元配列を定義できます。多次元配列を定義するには、 Index、次元数、数値データの定義を表すDimensionalDescriptionを記述します。 各情報は、Indexを基に定義されているため、 Indexは重複しないように記述します。

例えば、1次元に草丈(単位はcm)を、2次元に葉面積(単位はcm2) を定義する場合のコードを以下に示します。

 VectorItem vectorItem = new VectorItem();
 DimensionalDescription dd1 = new DimensionalDescription();
 DimensionalDescription dd2 = new DimensionalDescription();
 
 vectorItem.setIndex(1);
 vectorItem.setNumberOfDimension(2);
 
 dd1.setName("草丈");
 dd1.setUnit("cm");
 dd2.setName("葉面積");
 dd2.setUnit("cm2");
 
 vectorItem.addDimensionalDescription(dd1);
 vectorItem.addDimensionalDescription(dd2);
 
 bixpp.getRecordingDefinition().addItem(vectorItem);
 

作成者:

Shiozawa

関連項目:

RecordingDefinition, DataItem, ImageItem, EventItem, SoundItem, DescriptionItem, Vector, 直列化された形式

コンストラクタの概要

VectorItem()
デフォルトコンストラクタです。

VectorItem(long index, java.lang.String name)
Indexと名前を指定してVectorItemオブジェクトを作ります。

メソッドの概要

void	addDimensionalDescription(DimensionalDescription vDimensionalDescription) 多次元配列の持つ数値データの定義を表す DimensionalDescriptionを追加します。
void	addDimensionalDescription(int index, DimensionalDescription vDimensionalDescription) 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを 指定された位置に挿入します。
void	clearDimensionalDescription() 多次元配列の持つ数値データの定義を表す DimensionalDescriptionを削除します。
DimensionalDescription[]	getDimensionalDescription() 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを設定します。
DimensionalDescription	getDimensionalDescription(int index) 指定された位置にある 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを返します。
int	getDimensionalDescriptionCount() 多次元配列の持つ数値データの定義を表すDimensionalDescriptionの数を返します。
int	getNumberOfDimension() 多次元配列の次元数を表すNumberOfDimensionを返します。
boolean	removeDimensionalDescription(DimensionalDescription vDimensionalDescription) 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを削除します。
void	setDimensionalDescription(DimensionalDescription[] dimensionalDescriptionArray) 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを設定します。
void	setDimensionalDescription(int index, DimensionalDescription vDimensionalDescription) 指定された位置にある多次元配列の持つ数値データの定義を表すDimensionalDescriptionを置き換えます。
void	setNumberOfDimension(int numberOfDimension) 多次元配列の次元数を表すNumberOfDimensionを設定します。

クラス info.bix.tokai.bixpp.binding.DefinitionItem から継承されたメソッド

getComment, getIndex, getName, setComment, setIndex, setName

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

VectorItem

public VectorItem()

デフォルトコンストラクタです。

VectorItem

public VectorItem(long index,
                  java.lang.String name)

Indexと名前を指定してVectorItemオブジェクトを作ります。

パラメータ:

index - RecordingDefinition内で情報を定義しているIndex値

name - 多次元配列データの名前

メソッドの詳細

addDimensionalDescription

public void addDimensionalDescription(DimensionalDescription vDimensionalDescription)
                               throws java.lang.IndexOutOfBoundsException

多次元配列の持つ数値データの定義を表す DimensionalDescriptionを追加します。

パラメータ:

vDimensionalDescription - 多次元配列の持つ数値データの定義を表すDimensionalDescription

例外:

java.lang.IndexOutOfBoundsException - インデックス値が範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

addDimensionalDescription

public void addDimensionalDescription(int index,
                                      DimensionalDescription vDimensionalDescription)
                               throws java.lang.IndexOutOfBoundsException

多次元配列の持つ数値データの定義を表すDimensionalDescriptionを 指定された位置に挿入します。

パラメータ:

index - 多次元配列の持つ数値データの定義を表すDimensionalDescription が挿入されるインデックス値

vDimensionalDescription - 多次元配列の持つ数値データの定義を表すDimensionalDescription

例外:

java.lang.IndexOutOfBoundsException - インデックス値が範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

clearDimensionalDescription

public void clearDimensionalDescription()

多次元配列の持つ数値データの定義を表す DimensionalDescriptionを削除します。

getDimensionalDescription

public DimensionalDescription getDimensionalDescription(int index)
                                                 throws java.lang.IndexOutOfBoundsException

指定された位置にある 多次元配列の持つ数値データの定義を表すDimensionalDescriptionを返します。

パラメータ:

index - 返される多次元配列の持つ数値データの定義を表すDimensionalDescriptionのインデックス値

戻り値:

指定された位置にあるDimensionalDescription

例外:

java.lang.IndexOutOfBoundsException - インデックス値が範囲外の場合

getDimensionalDescription

public DimensionalDescription[] getDimensionalDescription()

多次元配列の持つ数値データの定義を表すDimensionalDescriptionを設定します。

戻り値:

多次元配列の持つ数値データの定義を表すDimensionalDescription

getDimensionalDescriptionCount

public int getDimensionalDescriptionCount()

多次元配列の持つ数値データの定義を表すDimensionalDescriptionの数を返します。

戻り値:

多次元配列の持つ数値データの定義を表すDimensionalDescriptionの数

getNumberOfDimension

public int getNumberOfDimension()

多次元配列の次元数を表すNumberOfDimensionを返します。

戻り値:

多次元配列の次元数

removeDimensionalDescription

public boolean removeDimensionalDescription(DimensionalDescription vDimensionalDescription)

多次元配列の持つ数値データの定義を表すDimensionalDescriptionを削除します。 削除が行われた場合はtrueを、行われなかった場合はfalseを返します。

パラメータ:

vDimensionalDescription -

setDimensionalDescription

public void setDimensionalDescription(int index,
                                      DimensionalDescription vDimensionalDescription)
                               throws java.lang.IndexOutOfBoundsException

指定された位置にある多次元配列の持つ数値データの定義を表すDimensionalDescriptionを置き換えます。

パラメータ:

index - 置換される多次元配列の持つ数値データの定義を表すDimensionalDescriptionのインデックス

vDimensionalDescription - 多次元配列の持つ数値データの定義を表すDimensionalDescription

例外:

java.lang.IndexOutOfBoundsException - インデックス値が範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setDimensionalDescription

public void setDimensionalDescription(DimensionalDescription[] dimensionalDescriptionArray)

多次元配列の持つ数値データの定義を表すDimensionalDescriptionを設定します。

パラメータ:

dimensionalDescriptionArray - 多次元配列の持つ数値データの定義を表すDimensionalDescription

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setNumberOfDimension

public void setNumberOfDimension(int numberOfDimension)

多次元配列の次元数を表すNumberOfDimensionを設定します。

パラメータ:

numberOfDimension - 多次元配列の次元数