ohymosj
クラス OhInputPort

java.lang.Object
  拡張ohymosj.OhObject
      拡張ohymosj.OhPort
          拡張ohymosj.OhSenderPort
              拡張ohymosj.OhSendPort
                  拡張ohymosj.OhInputPort
直系の既知のサブクラス:
OhInputFile

public abstract class OhInputPort
extends OhSendPort

基本型入力端子モデルを表すクラスです。

全体系の入力端子を作成するための基底クラスです。

抽象クラスです。

基本型入力端子は、全体系の入力端子を作成するための抽象クラスです。 ユーザは、このクラスを継承して全体系の入力端子のモデルを作成してください。 基本型入力端子のクラス宣言では、ユーザが実現すべき入力端子の基本仕様を定めています。 また、その実装では事前に用意できる機能を定義しています。

全体系モデルは、この基本型入力端子のクラスを継承してユーザが作成した 入力端子を通じてデータを入手するものとして設計されています。

全体系の内部に対して入力端子が入力データを受けとる役割をするという意味では、 入力端子は、基本型要素モデルの受信端子に似ていますが、全く別のものと 考えた方がよいです。

全体系モデルは、ファイル入出力、ネットワークによる入出力、キーボード入力、 CRT 出力など、種々雑多なデータの入出力に対応しなければなりません。 全体系モデルは、こうした雑多なデータを系の内部に取り込む時は、 全て OhDataPack 型のデータに変換しなければなりません。 また、シミュレーション結果をシミュレーション実行者に提供する時は、 OhDataPack 型で蓄積されているデータを シミュレーション実行者の望むデータ形式に変換しなければなりません。 このようなデータの変換に関する具体的処理は、 ユーザが作成する入力端子・出力端子で行なうことにし、 全体系モデルの方では、入力端子・出力端子を一定の手続きで操作することにしました。 すなわち、入力端子・出力端子は、 内部の定型的な処理と外部の処理との仲立ちをすることになります。

OhInputPort; Abstract class for creating input ports for a total system.

This is the base class from which the user creates his own input port models. Do not confuse "OhInputPort" with "OhReceivePort".

バージョン:
$Revision: 1.29 $ $Date: 2004/02/12 05:56:35 $
作成者:
satoh

フィールドの概要
 
クラス ohymosj.OhSendPort から継承したフィールド
_dataPackArray, _dctVec, _numberOfDataPacks, _protectPastDataFlag
 
クラス ohymosj.OhSenderPort から継承したフィールド
_bufferList, _commentString, _numberOfReceivers, _receiverArray
 
クラス ohymosj.OhObject から継承したフィールド
_className, _objectName, _objectNumber, _owner, NEWLINE
 
コンストラクタの概要
OhInputPort()
           デフォルトコンストラクタです。
OhInputPort(java.lang.String aPortName, int aPortNum)
           基底クラス OhSendPort のデフォルトコンストラクタを用い、 OhInputPort.init(String, int) を用いて、 メンバ変数を以下の通り初期化します。
 
メソッドの概要
 void calReq()
           端子は計算機能がないので、計算要請があってもどうしょうもない。
abstract  java.lang.String dataType()
           入力データパックのデータ値の型を文字列として返します。
 boolean init(java.lang.String aPortName, int aPortNum)
           オブジェクト名、オブジェクト番号を初期化します。
abstract  void inputData()
           入力データを入力端子に記憶します。
 
クラス ohymosj.OhSendPort から継承したメソッド
areYouReady, canYouGetData, canYouSwitch, clearDataPack, dataPackStock, forgetDataPackStock, getDataPack, getDataPack, getDataPackArray, getDctVec, getNewestDataTime, getNumberOfDataPacks, getOldestDataTime, init, reduceDataPackStock, saveSendPortStock, sendByString, setDataPackArray, setDctVec, setProtectPastDataFlag
 
クラス ohymosj.OhSenderPort から継承したメソッド
getCommentString, getNecessaryTimeFrom, getNecessaryTimeTo, printConnection, registerReceiver, setCommentString
 
クラス ohymosj.OhPort から継承したメソッド
canYouGetData, cPrint, create, getDataPack, getDataPack, setSender
 
クラス ohymosj.OhObject から継承したメソッド
getAbsName, getClassName, getObjectName, getObjectNumber, getOwner, getTopOwner, objCompare, objCompare, objCompare, oPrint, setOwner
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OhInputPort

public OhInputPort()
            throws OhError
デフォルトコンストラクタです。

デフォルトコンストラクタは OhInputPort.init(String, int) を実行しません。 その結果、以下の設定となります。

  • _objectName : null
  • _objectNumber : -1
  • その他のメンバ変数に対する処理は引数つきコンストラクタと同じです。 この場合、OhInputPort.init(String, int) を 用いてメンバ変数を初期化して下さい。

    例外:
    OhError - if an error occurs

    OhInputPort

    public OhInputPort(java.lang.String aPortName,
                       int aPortNum)
                throws OhError
    基底クラス OhSendPort のデフォルトコンストラクタを用い、 OhInputPort.init(String, int) を用いて、 メンバ変数を以下の通り初期化します。

  • _className : "OhInputPort"
  • _objectName : aPortName
  • _objectNumber : aPortNum
  • _owner : null
  • _bufferList : メモリに確保する。(接続作業用)
  • _receiverArray : null
  • _numberOfReceivers : -1
  • _dataPackArray : null
  • _numberOfDataPacks : -1
  • パラメータ:
    aPortName - a String value
    aPortNum - an int value
    例外:
    OhError - if an error occurs
    メソッドの詳細

    dataType

    public abstract java.lang.String dataType()
    入力データパックのデータ値の型を文字列として返します。

    抽象メソッドです。

    Returns the string which shows data type treated by the current input-port. Because this is pure virtual, the method must be defined in derived classes from this class.

    Example
    public String dataType() { return "double"; }
    We call the string returned by this funcion "dataType".

    定義:
    クラス OhSendPort 内の dataType
    戻り値:
    a String value

    inputData

    public abstract void inputData()
                            throws OhError
    入力データを入力端子に記憶します。

    抽象メソッドです。

    各入力端子で、入力データからデータパックを作成し、 データパックを記憶するメソッドを定義して下さい。

    Sending input data.

    With each input terminal, Please create a data pack from input data, and define the method which sends a data pack.

    例外:
    OhError

    init

    public boolean init(java.lang.String aPortName,
                        int aPortNum)
                 throws OhError
    オブジェクト名、オブジェクト番号を初期化します。

    Initialization.

    オーバーライド:
    クラス OhSendPort 内の init
    パラメータ:
    aPortName - a String value
    aPortNum - an int value
    戻り値:
    a boolean value
    例外:
    OhError - if an error occurs

    calReq

    public void calReq()
                throws OhCannotGetDataError,
                       OhError
    端子は計算機能がないので、計算要請があってもどうしょうもない。 必ず例外 OhCannotGetDataError を投げます。

    Since there is no calculation method in a file, even if there is a calculation request, it cannot carry out what, either.

    オーバーライド:
    クラス OhSendPort 内の calReq
    例外:
    OhCannotGetDataError - if an error occurs
    OhError - if an error occurs