ConstantSource.java

/*
 * $Id: ConstantSource.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 org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
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.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 ConstantSource<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, StringExternalizable {

  /** 定数信号 */
  @Parameter(name = "constant", description = "ConstantSource.1", update = true, internationalization = true)
  private RM constant =this.sunit.createZeroGrid(1, 1);

  /**
   * 新しく生成された<code>ConstantSource</code>オブジェクトを初期化します。
   * 
   * @param constant 定数
   * @param sunit unit of scalar
   */
  public ConstantSource(final RM constant, RS sunit) {
    super(constant.getRowSize(), sunit);
    this.constant = constant.createClone();
  }

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

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation(final RS t) {
    return this.constant.createClone();
  }

  /**
   * 定数を設定します。
   * 
   * @param constant 定数
   */
  public void setConstant(final RM constant) {
    this.constant = constant.createClone();
    setOutputSize(constant.getRowSize());
  }

  /**
   * 定数を返します。
   * 
   * @return 定数
   */
  public RM getConstant() {
    return this.constant.createClone();
  }

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

    return false;
  }

  /**
   * @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;
    }
    ConstantSource<RS,RM,CS,CM> castedObj = (ConstantSource<RS,RM,CS,CM>)o;
    return ((this.constant == null ? castedObj.constant == null : this.constant.equals(castedObj.constant)));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.constant == null ? 0 : this.constant.hashCode());
    return hashCode;
  }
}