StepSource.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.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.ode.PiecewiseContinuousAlgebraicSystem;
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.SIunit;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * ステップ信号を発生するシステムを表すクラスです。
 * 
 * @author Koga Laboratory
 * @version $Revision: 1.6 $, 2005/06/15
 * @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 StepSource<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 ContinuousSource<RS,RM,CS,CM> implements PiecewiseContinuousAlgebraicSystem<RS,RM,CS,CM>, StringExternalizable {

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

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

  /**
   * 新しく生成された<code>StepSource</code>オブジェクトを初期化します。
   * 
   * @param finalValue 最終値
   * @param sunit unit of scalar
   */
  public StepSource(final RS finalValue, RS sunit) {
    this(sunit.create(0), finalValue, sunit.create(0), sunit);
  }

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

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation(final RS t) {
    if (t.isGreaterThanOrEquals(this.delayTime)) {
      RS[] oo = this.sunit.createArray(1);
      oo[0] = this.finalValue;
      return this.sunit.createGrid(oo);
    }
    
    RS[] oo = this.sunit.createArray(1);
    oo[0]= this.initialValue;
    return this.sunit.createGrid(oo);
  }

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

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

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

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

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

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

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

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

    if (piece1.equals(piece2)) {
      return this.sunit.getNaN();
    }

    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;
    }
    StepSource<RS,RM,CS,CM> castedObj = (StepSource<RS,RM,CS,CM>)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 + (this.initialValue.hashCode() ^ (this.initialValue.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.finalValue.hashCode() ^ (this.finalValue.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.delayTime.hashCode() ^ (this.delayTime.hashCode() >>> 32));
    return hashCode;
  }
}