|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectohymosj.OhObject
ohymosj.OhPort
ohymosj.OhReceivePort
ohymosj.OhOutputPort
ohymosj.OhOutputFile
全体系内で受信したデータパックをファイルに記録します。
抽象クラスです。
OhOutputPort クラスから派生され、
OhOutputFileDouble,
OhOutputFileInt,
OhOutputFileLong,
OhOutputFileFloat,
クラスを派生します。
OhOutputFile; Model for output ports which receive datapacks and print them in a file.
Class OhOutputFile stores "output file name" in OhObject._objectName. Methods to output received datapacks to the output file are defined as its methods.
フィールドの概要 | |
protected java.lang.String |
_commentString
|
protected OhTimePoint |
_lastDataTime
|
protected int |
_lineLength
|
クラス ohymosj.OhReceivePort から継承したフィールド |
_sender |
クラス ohymosj.OhObject から継承したフィールド |
_className, _objectName, _objectNumber, _owner, NEWLINE |
コンストラクタの概要 | |
OhOutputFile()
|
|
OhOutputFile(java.lang.String aFileName)
|
|
OhOutputFile(java.lang.String aFileName,
int aLineLength)
|
メソッドの概要 | |
void |
cPrint(java.io.PrintWriter aPw,
java.lang.String aHead)
|
abstract java.lang.String |
dataType()
|
OhTimePoint |
getLastDataTime()
|
int |
getLineLength()
|
OhTimePoint |
getNecessaryTimeFrom()
|
OhTimePoint |
getNecessaryTimeTo()
|
boolean |
init(java.lang.String aFileName)
|
boolean |
init(java.lang.String aFileName,
int aLineLength)
|
abstract void |
makeStringData(java.lang.String aStr,
java.lang.Object aDataPack)
|
void |
oPrint(java.io.PrintWriter aPw,
java.lang.String aHead)
|
void |
outputData()
|
void |
setCommentString(java.lang.String aCmt)
|
boolean |
writeHeader()
|
クラス ohymosj.OhPort から継承したメソッド |
create, getDataPack, getDataPack, registerReceiver |
クラス ohymosj.OhObject から継承したメソッド |
getAbsName, getClassName, getObjectName, getObjectNumber, getOwner, getTopOwner, objCompare, objCompare, objCompare, setOwner |
クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
protected int _lineLength
この長さは、このオブジェクトのコンストラクタで指定したものです。
The maximum length of an output data string.
protected OhTimePoint _lastDataTime
Data record time of the last output data.
protected java.lang.String _commentString
The comment string written out to a file.
コンストラクタの詳細 |
public OhOutputFile()
デフォルトコンストラクタは OhOutputFile.init(String, int) を実行しません。 その結果、以下の設定となります。
その他のメンバ変数に対する処理は引数つきコンストラクタと同じです。 この場合、OhOutputFile.init(String, int) を 用いてメンバ変数を初期化して下さい。
public OhOutputFile(java.lang.String aFileName, int aLineLength) throws OhError
aFileName
- a String
valueaLineLength
- an int
value
public OhOutputFile(java.lang.String aFileName) throws OhError
aFileName
- a String
value
OhError
- if an error occurs
メソッドの詳細 |
public abstract java.lang.String dataType()
抽象メソッドです。
This is an abstract method. Returns a string which expresses the type of datapacks received by the current object.
OhOutputPort
内の dataType
String
valuepublic abstract void makeStringData(java.lang.String aStr, java.lang.Object aDataPack)
抽象メソッドです。
出力ファイル1行には、1個のデータパックのデータ内容を記述します。
Writes the content of datapack aDataPack into the area to which aStr points. The space which aStr points to must be large enough to store the content of the datapack.
Since this is an abstract method, implementation of this function is compulsory in derived classes.
aStr
- a String
valueaDataPack
- an Object
valuepublic boolean init(java.lang.String aFileName, int aLineLength) throws OhError
_lineLength が 0 より大きい場合、二重設定と判断して false を返します。 _lineLength が 0 以下ならば、_lineLength を aLineLength に設定して true を返します。
Initialization.
OhOutputPort
内の init
aFileName
- a String
valueaLineLength
- an int
value
boolean
value
OhError
public boolean init(java.lang.String aFileName) throws OhError
_lineLength が 0 より大きい場合、二重設定と判断して false を返します。
Initialization.
aFileName
- a String
value
boolean
value
OhError
- if an error occurspublic int getLineLength()
この長さは、このオブジェクトのコンストラクタで指定したものです。
Returns "_lineLength".
int
valuepublic OhTimePoint getLastDataTime()
Returns "_lastDataTime".
OhTimePoint
valuepublic void setCommentString(java.lang.String aCmt)
Copys the string "aCmt" to the field "_commentString". The string copied to "_commentString" will be printed out into the output file, while the method "writeHeader()" is executed. See the source code of "writeHeader()".
aCmt
- a String
valuepublic boolean writeHeader() throws java.io.IOException
出力ファイルのヘッダとして、 収録データパックを送信してきた送信端子に関する情報を記入します。
また、データ補間型配列の値を表示します。
【例】
# tplkin.oa # -------------------------------------------------------------------- # OhSendDouble sp 0 # _owner > PowerLawKinematicWave stream 0 # _owner >> OhScfTotalSystem totalSystem 0 # -------------------------------------------------------------------- # DataConnectionType = 0:BROKENLINE 1:STEP 2:PULSE 3:NOINTP #& dctVec 1 0ヘッダ部分には行頭に # を書き込み、コメントアウトするので、 この出力ファイルを再び入力ファイルとして用いることができます。
出力ファイルがオープンできないと例外を送出します。
ヘッダ書式を変更する場合は、派生クラスで再定義して下さい。
[RETURN] ・true --> 正常に記入できた場合。 ・false -> 出力ファイルがオープンできなかった場合。
Writes a header part to output file. The header contains
If the output file cannot be opened, this method returns "false".
boolean
value
java.io.IOException
- if an error occurspublic void outputData() throws java.io.IOException
まず、出力ファイル _objectName を追加書きモードでオープンし、 オープンできない場合は return します。
次に、受信データパック配列 _dataPackArray の先頭に格納されているデータパックから順番に OhOutputFile.makeStringData(String, Object) を用いてデータ文字列を作成し、出力ファイルに記入します。
※注意※
受信データパックはこのメソッドの中で取得されます。 モデル OhOutputFile は受信端子の派生モデルであって、 データパックをストックする機能はありません。
Writing of output data.
OhOutputPort
内の outputData
java.io.IOException
- if an error occurspublic OhTimePoint getNecessaryTimeFrom()
受信源の送信端子に getNecessaryTimeFrom() 以降 getNecessaryTimeTo 以前のデータパックを消去しないように指示するために定義しました。
[RETURN] ・OhTimePoint データ必要時刻
Returns necessary data time.
OhReceivePort
内の getNecessaryTimeFrom
OhTimePoint
valuepublic OhTimePoint getNecessaryTimeTo()
受信源の送信端子に getNecessaryTimeFrom() 以降 getNecessaryTimeTo 以前のデータパックを消去しないように指示するために定義しました。
[RETURN] ・OhTimePoint データ必要時刻
Returns necessary data time.
OhReceivePort
内の getNecessaryTimeTo
OhTimePoint
valuepublic void cPrint(java.io.PrintWriter aPw, java.lang.String aHead)
出力ファイル名とこの端子の受信元送信端子の情報を ストリーム aPw(引数)に出力します。
[in] aPw : オブジェクト情報を出力するストリーム [in] aHead: コメント文字列
Outputs an object information.
OhPort
内の cPrint
aPw
- a PrintWriter
valueaHead
- a String
valuepublic void oPrint(java.io.PrintWriter aPw, java.lang.String aHead)
出力ファイル名とこの端子の受信元送信端子の情報を ストリーム aPw(引数)に出力します。
[in] aPw : オブジェクト情報を出力するストリーム [in] aHead: コメント文字列
Outputs an object information. The information includes the "_owner"'s information.
OhObject
内の oPrint
aPw
- a PrintWriter
valueaHead
- a String
value
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |