DoubleRampSource.java

/*
 * $Id: RampSource.java,v 1.5 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.ParameterUpdator;
import org.mklab.tool.control.system.parameter.StringExternalizable;


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

public class DoubleRampSource extends DoubleContinuousSource implements ParameterUpdator, DoublePiecewiseContinuousAlgebraicSystem, StringExternalizable {

  /** オフセット */
  @Parameter(name = "offset", description = "RampSource.1", internationalization = true)
  private double offset;
  /** 傾き */
  @Parameter(name = "slope", description = "RampSource.3", internationalization = true)
  private double slope;
  /** 遅れ時間 */
  @Parameter(name = "delayTime", description = "RampSource.5", internationalization = true)
  private double delayTime;

  /**
   * 新しく生成された<code>RampSource</code>オブジェクトを初期化します。
   * 
   * @param offset オフセット
   * @param slope 傾き
   * @param delayTime 遅れ時間
   */
  public DoubleRampSource(final double offset, final double slope, final double delayTime) {
    super(1);
    this.offset = offset;
    this.slope = slope;
    this.delayTime = delayTime;
  }

  /**
   * 新しく生成された<code>RampSource</code>オブジェクトを初期化します。
   * 
   * @param slope 傾き
   */
  public DoubleRampSource(final double slope) {
    this(0.0, slope, 0.0);
  }

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

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

  /**
   * オフセットを設定します。
   * 
   * @param offset オフセット
   */
  public void setOffset(final double offset) {
    this.slope = offset;
  }

  /**
   * オフセットを返します。
   * 
   * @return オフセット
   */
  public double getOffset() {
    return this.offset;
  }

  /**
   * 傾きを設定します。
   * 
   * @param slope 傾き
   */
  public void setSlope(final double slope) {
    this.slope = slope;
  }

  /**
   * 傾きを返します。
   * 
   * @return 傾き
   */
  public double getSlope() {
    return this.slope;
  }

  /**
   * 遅れ時間を設定します。
   * 
   * @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;
    }
    DoubleRampSource castedObj = (DoubleRampSource)o;
    return ((this.offset == castedObj.offset) && (this.slope == castedObj.slope) && (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.offset) ^ (Double.doubleToLongBits(this.offset) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.slope) ^ (Double.doubleToLongBits(this.slope) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.delayTime) ^ (Double.doubleToLongBits(this.delayTime) >>> 32));
    return hashCode;
  }

  /**
   * @see org.mklab.tool.control.system.parameter.ParameterUpdator#updateWith(java.lang.String)
   */
  public boolean updateWith(String parameter) {
    if (parameter.equals("delayTime")) { //$NON-NLS-1$
      setDelayTime(this.delayTime);
      return true;
    }

    if (parameter.equals("offset")) { //$NON-NLS-1$
      setOffset(this.offset);
      return true;
    }

    if (parameter.equals("slope")) { //$NON-NLS-1$
      setSlope(this.slope);
      return true;
    }

    return false;
  }

}