DoublePulseSource.java

/*
 * $Id: PulseSource.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.SIunit;
import org.mklab.tool.control.system.parameter.StringExternalizable;


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

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

  /** オフセット */
  @Parameter(name = "offset", description = "PulseSource.1", internationalization = true)
  private double offset = 0;
  /** 大きさ */
  @Parameter(name = "amplitude", description = "PulseSource.3", internationalization = true)
  private double amplitude = 1.0;
  /** 周期 */
  @Parameter(name = "period", unit = SIunit.s, description = "PulseSource.5", internationalization = true)
  private double period = 2;
  /** 幅 */
  @Parameter(name = "pulseWidth", description = "PulseSource.7", internationalization = true)
  private double pulseWidth = 50;
  /** 位相の遅れ */
  @Parameter(name = "phaseDelay", unit = SIunit.s, description = "PulseSource.9", internationalization = true)
  private double phaseDelay = 0;

  /**
   * 新しく生成された<code>PulseSource</code>オブジェクトを初期化します。
   * 
   * @param offset オフセット
   * @param amplitude 大きさ
   * @param period 周期
   * @param pulseWidth 幅(%)
   * @param phaseDelay 位相の遅れ
   */
  public DoublePulseSource(final double offset, final double amplitude, final double period, final double pulseWidth, final double phaseDelay) {
    super(1);
    this.offset = offset;
    this.amplitude = amplitude;
    this.period = period;
    this.pulseWidth = pulseWidth;
    this.phaseDelay = phaseDelay;
  }

  /**
   * 新しく生成された<code>PulseSource</code>オブジェクトを初期化します。
   * 
   * @param amplitude 最終値
   * @param period 周期
   * @param pulseWidth 幅(%)
   */
  public DoublePulseSource(final double amplitude, final double period, final double pulseWidth) {
    this(0, amplitude, period, pulseWidth, 0);
  }

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

  /**
   * {@inheritDoc}
   */
  @Override
  public DoubleMatrix outputEquation(final double t) {
    final double compensatedTime = t - this.phaseDelay;
    final int cycle = (int)Math.floor(compensatedTime / this.period);
    double percentage = (compensatedTime - this.period * cycle) / this.period * 100;

    if (percentage < this.pulseWidth) {
      return new DoubleMatrix(new double[] {this.offset + this.amplitude});
    }
    return new DoubleMatrix(new double[] {this.offset});
  }

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

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

  /**
   * 大きさを設定します。
   * 
   * @param amplitude 大きさ
   */
  public void setAmplitude(final double amplitude) {
    this.amplitude = amplitude;
  }

  /**
   * 大きさを返します。
   * 
   * @return 大きさ
   */
  public double getAmplitude() {
    return this.amplitude;
  }

  /**
   * 幅を設定します。
   * 
   * @param pulseWidth 幅(%)
   */
  public void setPulseWidth(final double pulseWidth) {
    this.pulseWidth = pulseWidth;
  }

  /**
   * 幅(%)を返します。
   * 
   * @return 幅
   */
  public double getPulseWidth() {
    return this.pulseWidth;
  }

  /**
   * 周期を設定します。
   * 
   * @param period 周期
   */
  public void setPeriodTime(final double period) {
    this.period = period;
  }

  /**
   * 周期を返します。
   * 
   * @return 周期
   */
  public double getPeriodTime() {
    return this.period;
  }

  /**
   * 位相の遅れを設定します。
   * 
   * @param phaseDelay 位相の遅れ
   */
  public void setPhaseDelay(final double phaseDelay) {
    this.period = phaseDelay;
  }

  /**
   * 位相の遅れを返します。
   * 
   * @return 位相の遅れ
   */
  public double getPhaseDelay() {
    return this.phaseDelay;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public List<Integer> getPiece(final double t,  final DoubleMatrix u) {
    final double compensatedTime = t - this.phaseDelay;
    final int cycle = (int)Math.floor(compensatedTime / this.period);
    double percentage = (compensatedTime - this.period * cycle) / this.period * 100;

    if (percentage < this.pulseWidth) {
      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;
    }

    final double compensatedTime = t1 - this.phaseDelay;
    final int cycle = (int)Math.floor(compensatedTime / this.period);
    double percentage = (compensatedTime - this.period * cycle) / this.period * 100;

    if (percentage < this.pulseWidth) {
      return this.phaseDelay + this.period * cycle + this.period * this.pulseWidth / 100;
    }

    return this.phaseDelay + this.period * (cycle + 1);
  }

  /**
   * @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;
    }
    DoublePulseSource castedObj = (DoublePulseSource)o;
    return ((this.offset == castedObj.offset) && (this.amplitude == castedObj.amplitude) && (this.period == castedObj.period) && (this.pulseWidth == castedObj.pulseWidth) && (this.phaseDelay == castedObj.phaseDelay));
  }

  /**
   * @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.amplitude) ^ (Double.doubleToLongBits(this.amplitude) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.period) ^ (Double.doubleToLongBits(this.period) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.pulseWidth) ^ (Double.doubleToLongBits(this.pulseWidth) >>> 32));
    hashCode = 31 * hashCode + (int)(Double.doubleToLongBits(this.phaseDelay) ^ (Double.doubleToLongBits(this.phaseDelay) >>> 32));
    return hashCode;
  }

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

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

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

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

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

    return false;
  }
}