PulseSource.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.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.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
 * @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 PulseSource<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 ParameterUpdator, PiecewiseContinuousAlgebraicSystem<RS,RM,CS,CM>, StringExternalizable {

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

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

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

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

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation(final RS t) {
    final RS compensatedTime = t.subtract(this.phaseDelay);
    final int cycle = (int)compensatedTime.divide(this.period).floor().toDouble();
    RS percentage = compensatedTime.subtract(this.period.multiply(cycle)).divide(this.period).multiply(100);

    if (percentage.isLessThan(this.pulseWidth)) {
      RS[] oo = this.sunit.createArray(1);
      oo[0]= this.offset.add(this.amplitude);
      return this.sunit.createGrid(oo);
    }
    RS[] oo = this.sunit.createArray(1);
    oo[0]= this.offset;
    return this.sunit.createGrid(oo);
  }

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

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

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

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

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

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

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

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

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

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

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public List<Integer> getPiece(final RS t,  final RM u) {
    final RS compensatedTime = t.subtract(this.phaseDelay);
    final int cycle = (int)compensatedTime.divide(this.period).floor().toDouble();
    RS percentage = compensatedTime.subtract(this.period.multiply(cycle)).divide(this.period).multiply(100);

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

    final RS compensatedTime = t1.subtract(this.phaseDelay);
    final int cycle = (int)compensatedTime.divide(this.period).floor().toDouble();
    RS percentage = compensatedTime.subtract(this.period.multiply(cycle)).divide(this.period).multiply(100);

    if (percentage.isLessThan(this.pulseWidth)) {
      return this.phaseDelay.add(this.period.multiply(cycle)).add(this.period.multiply(this.pulseWidth).divide(100));
    }

    return this.phaseDelay.add(this.period.multiply(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;
    }
    PulseSource<RS,RM,CS,CM> castedObj = (PulseSource<RS,RM,CS,CM>)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 + (this.offset.hashCode() ^ (this.offset.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.amplitude.hashCode()^ (this.amplitude.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.period.hashCode() ^ (this.period.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.pulseWidth.hashCode() ^ (this.pulseWidth.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.phaseDelay.hashCode() ^ (this.phaseDelay.hashCode() >>> 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;
  }
}