VariableSource.java

/*
 * Created on 2007/06/08
 * Copyright (C) 2007 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.source;

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.scalar.ComplexNumericalScalar;
import org.mklab.nfc.scalar.RealNumericalScalar;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * 変数からの入力器を表わすクラスです。
 * 
 * @author koga
 * @version $Revision: 1.5 $, 2007/06/08
  * @param <RS> type of real scalar
 * @param <RM> type of real matrix
 * @param <CS> type of complex scalar
 * @param <CM> type of complex matrix
*/
public class VariableSource<RS extends RealNumericalScalar<RS,RM,CS,CM>, RM extends RealNumericalMatrix<RS,RM,CS,CM>, CS extends ComplexNumericalScalar<RS,RM,CS,CM>, CM extends ComplexNumericalMatrix<RS,RM,CS,CM>> extends ImportSource<RS,RM,CS,CM> implements StringExternalizable {

  /** 変数の名前 */
  @Parameter(name = "name", description = "VariableSource.0", internationalization = true)
  private String variableName = "u"; //$NON-NLS-1$

  /**
   * 新しく生成された<code>VariableSource</code>オブジェクトを初期化します。
   * @param sunit unit of scalar
   */
  public VariableSource(RS sunit) {
    super(sunit);
  }

  /**
   * @see org.mklab.tool.control.system.source.Importer#close()
   */
  public void close() {
    //
  }

  /**
   * @see org.mklab.tool.control.system.source.Importer#importData()
   */
  public void importData() {
    if (isActive()) {
      return;
    }
  }

  /**
   * @see org.mklab.tool.control.system.source.Importer#open()
   */
  public void open() {
    //
  }

  /**
   * 名前を返します。
   * 
   * @return 名前
   */
  public String getVariableName() {
    return this.variableName;
  }

  /**
   * 名前を設定します。
   * 
   * @param variableName 名前
   */
  public void setVariableName(final String variableName) {
    this.variableName = variableName;
  }

  /**
   * @see org.mklab.tool.control.system.parameter.StringExternalizable#getString(java.lang.String)
   */
  public String getString(String key) {
    return Messages.getString(key);
  }

  /**
   * @see org.mklab.tool.control.system.source.ImportSource#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!super.equals(o)) {
      return false;
    }
    if (o == null) {
      return false;
    }
    if (o.getClass() != getClass()) {
      return false;
    }
    VariableSource<RS,RM,CS,CM> castedObj = (VariableSource<RS,RM,CS,CM>)o;
    return ((this.variableName == null ? castedObj.variableName == null : this.variableName.equals(castedObj.variableName)));
  }

  /**
   * @see org.mklab.tool.control.system.source.ImportSource#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.variableName == null ? 0 : this.variableName.hashCode());
    return hashCode;
  }
}