DisplaySink.java

/*
 * Created on 2007/02/05
 * Copyright (C) 2007 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.sink;

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.nleq.NonLinearEquationSolver;
import org.mklab.nfc.ode.EquationSolver;
import org.mklab.nfc.ode.SolverStopException;
import org.mklab.nfc.scalar.ComplexNumericalScalar;
import org.mklab.nfc.scalar.RealNumericalScalar;
import org.mklab.tool.control.system.parameter.Parameter;


/**
 * ディスプレイへの出力器を表わすクラスです。
 * 
 * @author koga
 * @version $Revision: 1.20 $, 2007/02/05
 * @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 DisplaySink<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 ExportSink<RS, RM, CS, CM> {

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

  /** 各時刻で表示するならばtrue */
  @Parameter(name = "display", description = "DisplaySink.4", internationalization = true)
  private boolean displayable = true;

  /** 出力の表示に使用するディスプレイです。 */
  private Display<RS, RM, CS, CM> display = new ConsoleDisplay<>();

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

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation(final RS t, final RM u) throws SolverStopException {
    // 方程式のソルバーが仮の値で計算しているか判定します
    final boolean solverTrial = EquationSolver.isTrial() || NonLinearEquationSolver.isTrial();

    if (solverTrial == false && this.displayable) {
      this.display.display(t, u);
    }

    return super.outputEquation(t, u);
  }

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

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

  /**
   * 表示の有無を返します
   * 
   * @return 表示
   */
  public boolean isDisplayable() {
    return this.displayable;
  }

  /**
   * 表示の有無を設定します
   * 
   * @param display 表示
   */
  public void setDisplayable(final boolean display) {
    this.displayable = display;
  }

  /**
   * 出力表示に使用するディスプレイを取得します。
   * 
   * @return 出力表示に使用するディスプレイ
   */
  public Display<RS, RM, CS, CM> getDisplay() {
    return this.display;
  }

  /**
   * 出力表示に使用するディスプレイを設定します。
   * 
   * @param display 出力表示に使用するディスプレイ
   * @throws NullPointerException nullが与えられた場合
   */
  public void setDisplay(Display<RS, RM, CS, CM> display) {
    if (display == null) {
      throw new NullPointerException();
    }
    this.display = display;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String getString(String key) {
    return Messages.getString(key);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(final Object o) {
    if (this == o) {
      return true;
    }
    if (!super.equals(o)) {
      return false;
    }
    if (o == null) {
      return false;
    }
    if (o.getClass() != getClass()) {
      return false;
    }
    final DisplaySink<RS, RM, CS, CM> castedObj = (DisplaySink<RS,RM,CS,CM>)o;
    return ((this.name == null ? castedObj.name == null : this.name.equals(castedObj.name)) && (this.displayable == castedObj.displayable));
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.name == null ? 0 : this.name.hashCode());
    hashCode = 31 * hashCode + (this.displayable ? 1231 : 1237);
    return hashCode;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void open() {
    this.display.open(getInputSize());
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void close() {
    this.display.close();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void exportData() {
    // do nothing
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean isActive() {
    return this.display != null;
  }

  /**
   * コンソールへの出力を行うディスプレイです。
   * 
   * @author Yuhi Ishikura
   * @version $Revision$, 2010/02/10
   * @param <RS2> type of real scalar
   * @param <RM2> type of real matrix
   * @param <CS2> type of complex scalar
   * @param <CM2> type of complex matrix
   */
  class ConsoleDisplay<RS2 extends RealNumericalScalar<RS2, RM2, CS2, CM2>, RM2 extends RealNumericalMatrix<RS2, RM2, CS2, CM2>, CS2 extends ComplexNumericalScalar<RS2, RM2, CS2, CM2>, CM2 extends ComplexNumericalMatrix<RS2, RM2, CS2, CM2>>
      implements Display<RS2, RM2, CS2, CM2> {

    /**
     * {@inheritDoc}
     */
    @Override
    public void display(RS2 t, RM2 u) {
      for (int row = 1; row <= u.getRowSize(); row++) {
        System.out.print(u.getElement(row, 1).toString());
        if (row != u.getRowSize()) {
          System.out.print(", "); //$NON-NLS-1$
        }
      }
      System.out.println(""); //$NON-NLS-1$
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() {
      // do nothing
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void open(int inputCount) {
      // do nothing
    }

  }

}