DoubleStepSource.java

/*
 * $Id: StepSource.java,v 1.6 2008/07/15 15:27:15 koga Exp $
 *
 * Copyright (C) 2004 Koga Laboratory. All rights reserved.
 *
 */

package org.mklab.tool.control.system.source;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.mklab.nfc.matrix.DoubleMatrix;
import org.mklab.nfc.ode.DoublePiecewiseContinuousAlgebraicSystem;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.SIunit;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * ステップ信号を発生するシステムを表すクラスです。
 * 
 * @author Koga Laboratory
 * @version $Revision: 1.6 $, 2005/06/15
 */

public class DoubleStepSource extends DoubleContinuousSource implements DoublePiecewiseContinuousAlgebraicSystem, StringExternalizable {

  /** 初期値 */
  @Parameter(name = "initialValue", description = "StepSource.1", internationalization = true)
  private double initialValue = 0;
  /** 最終値 */
  @Parameter(name = "finalValue", description = "StepSource.3", internationalization = true)
  private double finalValue = 1.0;
  /** 遅れ時間 */
  @Parameter(name = "delayTime", unit = SIunit.s, description = "StepSource.5", internationalization = true)
  private double delayTime = 0;

  /**
   * 新しく生成された<code>StepSource</code>オブジェクトを初期化します。
   * 
   * @param initialValue 初期値
   * @param finalValue 最終値
   * @param delayTime 遅れ時間
   */
  public DoubleStepSource(final double initialValue, final double finalValue, final double delayTime) {
    super(1);
    this.initialValue = initialValue;
    this.finalValue = finalValue;
    this.delayTime = delayTime;
  }

  /**
   * 新しく生成された<code>StepSource</code>オブジェクトを初期化します。
   * 
   * @param finalValue 最終値
   */
  public DoubleStepSource(final double finalValue) {
    this(0.0, finalValue, 0.0);
  }

  /**
   * 新しく生成された<code>StepSource</code>オブジェクトを初期化します。
   */
  public DoubleStepSource() {
    this(1.0);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public DoubleMatrix outputEquation(final double t) {
    if (t >= this.delayTime) {
      return new DoubleMatrix(new double[] {this.finalValue});
    }
    return new DoubleMatrix(new double[] {this.initialValue});
  }

  /**
   * 初期値を設定します。
   * 
   * @param initialValue 初期値
   */
  public void setInitialValue(final double initialValue) {
    this.initialValue = initialValue;
  }

  /**
   * 初期値を返します。
   * 
   * @return 初期値
   */
  public double getInitialValue() {
    return this.initialValue;
  }

  /**
   * 最終値を設定します。
   * 
   * @param finalValue 最終値
   */
  public void setFinalValue(final double finalValue) {
    this.finalValue = finalValue;
  }

  /**
   * 最終値を返します。
   * 
   * @return 最終値
   */
  public double getFinalValue() {
    return this.finalValue;
  }

  /**
   * 遅れ時間を設定します。
   * 
   * @param delayTime 遅れ時間
   */
  public void setDelayTime(final double delayTime) {
    this.delayTime = delayTime;
  }

  /**
   * 遅れ時間を返します。
   * 
   * @return 遅れ時間
   */
  public double getDelayTime() {
    return this.delayTime;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public List<Integer> getPiece(final double t,  final DoubleMatrix u) {
    if (t >= this.delayTime) {
      return new ArrayList<>(Arrays.asList(new Integer[] {1}));
    }
    return new ArrayList<>(Arrays.asList(new Integer[] {0}));
  }

  /**
   * {@inheritDoc}
   */
  public double getDiscontinuousPoint(final double t1, final DoubleMatrix u1, final double t2, final DoubleMatrix u2) {
    final List<Integer> piece1 = getPiece(t1, u1);
    final List<Integer> piece2 = getPiece(t2, u2);

    if (piece1.equals(piece2)) {
      return Double.NaN;
    }

    return this.delayTime;
  }

  /**
   * @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.SystemOperator#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;
    }
    DoubleStepSource castedObj = (DoubleStepSource)o;
    return ((this.initialValue == castedObj.initialValue) && (this.finalValue == castedObj.finalValue) && (this.delayTime == castedObj.delayTime));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.initialValue) ^ (Double.doubleToLongBits(this.initialValue) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.finalValue) ^ (Double.doubleToLongBits(this.finalValue) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.delayTime) ^ (Double.doubleToLongBits(this.delayTime) >>> 32));
    return hashCode;
  }
}