PFTimeEvaluator (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.system.performance.PFTimeEvaluator

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFTimeEvaluator
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
プラットフォーム及びコンポーネントの実行時間[msec]を測定するコンポーネント。
このコンポーネントからはイベントが発生しない。

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PFTimeEvaluator()
デフォルトコンストラクタ

コンストラクタ
コンストラクタと説明
`PFTimeEvaluator()` デフォルトコンストラクタ

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`java.lang.String`	`getItemName()` 現在(または直前)の計測項目名を返す。
`long`	`getTotalTime()` 総計測時間[msec]を返す。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`void`	`resume()` 計測を再開する。
`void`	`setAllowPullTransfer(boolean flag)` 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowPushTransfer(boolean flag)` 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
`void`	`setAllowRemoteInvocation(boolean flag)` 他PFからのコンポーネント連携要求に対する可否属性を設定する.
`void`	`setComponentID(int id)` コンポーネントIDを設定する。
`void`	`setComponentKey(java.lang.String key)` コンポーネントのキー情報を設定する
`void`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`sleep()` 計測を中断する。
`void`	`start()` 計測を開始する。
`void`	`start(java.lang.String name)` 計測項目名を入力して計測を開始する。
`java.lang.String`	`stop()` 計測を終了する。
`void`	`writeXML(PFXMLGenerator out)` コンポーネントのXML出力.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - PFTimeEvaluator
```
public PFTimeEvaluator()
```
    デフォルトコンストラクタ
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
    
    関連項目:
    
    PFComponent.getComponentName()
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー文字列
    
    関連項目:
    
    PFComponent.getComponentKey()
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントのキー情報を設定する
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - 設定するコンポーネントのキー
    
    関連項目:
    
    PFComponent.setComponentKey(java.lang.String)
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
    
    関連項目:
    
    PFComponent.getComponentID()
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
    
    関連項目:
    
    PFComponent.setComponentID(int)
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントの文字列表現を返す。
    
    関連項目:
    
    PFComponent.getComponentString()
  - getComponentPublicName
```
public java.lang.String getComponentPublicName()
```
    コンポーネント公開名を取得する.
    
    定義:
    
    getComponentPublicName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント公開名
  - setComponentPublicName
```
public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
```
    コンポーネント公開名を設定する.
    空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。また、既存コンポーネントとの重複も認めない.
    
    定義:
    
    setComponentPublicName インタフェース内 PFComponent
    
    パラメータ:
    
    publicName - 設定するコンポーネント公開名
    
    例外:
    
    PFComponentException - 規約に反する名前が設定されようとした場合
  - isAllowRemoteInvocation
```
public boolean isAllowRemoteInvocation()
```
    他PFからのコンポーネント連携要求に対する可否属性を取得する.
    
    定義:
    
    isAllowRemoteInvocation インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント連携要求可否属性
  - setAllowRemoteInvocation
```
public void setAllowRemoteInvocation(boolean flag)
```
    他PFからのコンポーネント連携要求に対する可否属性を設定する.
    
    定義:
    
    setAllowRemoteInvocation インタフェース内 PFComponent
    
    パラメータ:
    
    flag - コンポーネント連携要求に対する可否
  - isAllowPullTransfer
```
public boolean isAllowPullTransfer()
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPullTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Pull型コンポーネント転送要求可否属性
  - setAllowPullTransfer
```
public void setAllowPullTransfer(boolean flag)
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPullTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Pull型コンポーネント転送要求に対する可否
  - isAllowPushTransfer
```
public boolean isAllowPushTransfer()
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPushTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Push型コンポーネント転送要求可否属性
  - setAllowPushTransfer
```
public void setAllowPushTransfer(boolean flag)
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPushTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Push型コンポーネント転送要求に対する可否
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
    
    関連項目:
    
    PFComponent.localeUpdated()
  - readXML
```
public void readXML(PFXMLLoader in)
```
    コンポーネントのXML入力.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    コンポーネントのXML出力.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - start
```
public void start()
```
    計測を開始する。計測項目名は(UNKNOWN)となる。
  - start
```
public void start(java.lang.String name)
```
    計測項目名を入力して計測を開始する。
    
    パラメータ:
    
    name - 計測項目名
  - stop
```
public java.lang.String stop()
```
    計測を終了する。計測結果を文字列として返す。形式は、 "項目名"："計測時間" msec
    
    戻り値:
    
    計測結果文字列
  - sleep
```
public void sleep()
```
    計測を中断する。
  - resume
```
public void resume()
```
    計測を再開する。
  - getItemName
```
public java.lang.String getItemName()
```
    現在(または直前)の計測項目名を返す。
    
    戻り値:
    
    計測項目名
  - getTotalTime
```
public long getTotalTime()
```
    総計測時間[msec]を返す。
    
    戻り値:
    
    時間[msec](long)

クラス PFTimeEvaluator

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

PFTimeEvaluator

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

localeUpdated

readXML

writeXML

start

start

stop

sleep

resume

getItemName

getTotalTime