PortAdmin

java.lang.Object
- jp.go.aist.rtm.RTC.port.PortAdmin

public class PortAdmin
extends java.lang.Object

Portの管理を行うクラスです。

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`protected class`	`PortAdmin.find_port`
`protected class`	`PortAdmin.find_port_name`
`protected class`	`PortAdmin.port_prof_collect`

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

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

PortAdmin(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)
コンストラクタです。

コンストラクタ
コンストラクタと説明
`PortAdmin(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)` コンストラクタです。

メソッドのサマリー

メソッド
修飾子とタイプ	メソッドと説明
`void`	`activatePorts()` 全ての Port のインターフェースを activates する。
`boolean`	`addPort(PortBase port)` Regsiter the Port This operation registers the Port's servant given by argument.
`boolean`	`addPort(PortService port)` Regsiter the Port This operation registers the Port's servant given by argument.
`void`	`deactivatePorts()` 全ての Port のインターフェースを deactivates する。
`void`	`deletePort(PortBase port)` [local interface] Port の登録を削除する {@.ja 指定されたPortサーバントの登録を解除します。
`void`	`deletePort(PortService port)` [local interface] Port の登録を削除する {@.ja 指定されたPortサーバントの登録を解除します。
`void`	`deletePortByName(java.lang.String portName)` 名称指定によりPort の登録を解除する {@.ja 引数で指定された名前を持つ Port の登録を削除する。
`void`	`finalizePorts()` 全ての Port をdeactivateし登録を削除する登録されている全てのPortに対して、サーバントのdeactivateを行い、登録リストから削除する。
`PortBase`	`getPort(java.lang.String portName)` Port のサーバントのポインタの取得 {@.ja port_name で指定した Port のサーバントのポインタを返す。
`PortServiceListHolder`	`getPortList()` 登録されているPortのリストを取得します。
`PortProfileListHolder`	`getPortProfileList()` PorProfile リストの取得 addPort() により登録された Port の Profile リストを取得する。
`PortService`	`getPortRef(java.lang.String portName)` Port のオブジェクト参照の取得 {@.ja port_name で指定した Port のオブジェクト参照を返す。
`PortServiceListHolder`	`getPortServiceList()` Port リストの取得 addPort() により登録された Port のリストを取得する。
`void`	`registerPort(PortBase port)` Portサーバントを登録します。
`void`	`registerPort(PortService port)` Port を登録する {@.ja 引数 port で指定された Port のサーバントを登録する。
`boolean`	`removePort(PortBase port)` Port の登録を解除する {@.ja 引数 port で指定された Port の登録を解除する。
`boolean`	`removePort(PortService port)` Port の登録を解除する {@.ja 引数 port で指定された Port の登録を解除する。

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

- コンストラクタの詳細
  - PortAdmin
```
public PortAdmin(org.omg.CORBA.ORB orb,
         org.omg.PortableServer.POA poa)
```
    コンストラクタです。
    
    パラメータ:
    orb - ORBオブジェクト
    poa - POAオブジェクト
- メソッドの詳細
  - getPortList
```
public PortServiceListHolder getPortList()
```
    登録されているPortのリストを取得します。
    
    戻り値:
    Portオブジェクトリストを内包するPortServiceListHolderオブジェクト
  - getPortServiceList
```
public PortServiceListHolder getPortServiceList()
```
    Port リストの取得
    addPort() により登録された Port のリストを取得する。
    
    戻り値:
    Port リスト
  - activatePorts
```
public void activatePorts()
```
    全ての Port のインターフェースを activates する。
  - deactivatePorts
```
public void deactivatePorts()
```
    全ての Port のインターフェースを deactivates する。
  - getPortProfileList
```
public final PortProfileListHolder getPortProfileList()
```
    PorProfile リストの取得
    addPort() により登録された Port の Profile リストを取得する。A
    
    戻り値:
    Portオブジェクトリストを内包するPortServiceListHolderオブジェクト
  - getPortRef
```
public PortService getPortRef(java.lang.String portName)
```
    Port のオブジェクト参照の取得
    port_name で指定した Port のオブジェクト参照を返す。 port_name で指定する Port はあらかじめ addPort() で登録されていなければならない。
    
    パラメータ:
    portName - Portの名前
    
    戻り値:
    PortService_ptr 指定されたポート名を持つPortのCORBAオブジェクト参照を返します。合致するポート名を持つものが見つからない場合はnullを返します。
  - getPort
```
public PortBase getPort(java.lang.String portName)
```
    Port のサーバントのポインタの取得
    port_name で指定した Port のサーバントのポインタを返す。 port_name で指定する Port はあらかじめ addPort() で登録されていなければならない。
    
    パラメータ:
    portName - Portの名前
    
    戻り値:
    PortBase 指定されたポート名を持つPortサーバントのオブジェクト
  - addPort
```
public boolean addPort(PortBase port)
```
    Regsiter the Port
    This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.
    
    パラメータ:
    port - The Port's servant.
    
    戻り値:
    Register result (Successful:true, Failed:false)
  - addPort
```
public boolean addPort(PortService port)
```
    Regsiter the Port
    This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.
    
    パラメータ:
    port - The Port's servant.
    
    戻り値:
    Register result (Successful:true, Failed:false)
  - registerPort
```
public void registerPort(PortBase port)
```
    Portサーバントを登録します。
    
    パラメータ:
    port - 登録するPortサーバント
  - registerPort
```
public void registerPort(PortService port)
```
    Port を登録する
    引数 port で指定された Port のサーバントを登録する。登録された Port のサーバントはコンストラクタで与えられたPOA 上で activate され、そのオブジェクト参照はPortのProfileにセットされる。
    
    パラメータ:
    port - Port サーバント
  - removePort
```
public boolean removePort(PortBase port)
```
    Port の登録を解除する
    引数 port で指定された Port の登録を解除する。削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。
    
    パラメータ:
    port - Port サーバント
    
    戻り値:
    削除結果(削除成功:true，削除失敗:false)
  - removePort
```
public boolean removePort(PortService port)
```
    Port の登録を解除する
    引数 port で指定された Port の登録を解除する。削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。
    
    パラメータ:
    port - Port サーバント
    
    戻り値:
    削除結果(削除成功:true，削除失敗:false)
  - deletePort
```
public void deletePort(PortBase port)
```
    [local interface] Port の登録を削除する
    指定されたPortサーバントの登録を解除します。削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。
    
    パラメータ:
    port - Port サーバント
  - deletePort
```
public void deletePort(PortService port)
```
    [local interface] Port の登録を削除する
    指定されたPortサーバントの登録を解除します。削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。
    
    パラメータ:
    port - Port サーバント
  - deletePortByName
```
public void deletePortByName(java.lang.String portName)
```
    名称指定によりPort の登録を解除する
    引数で指定された名前を持つ Port の登録を削除する。削除時に Port は deactivate され、PortのProfileのリファレンスには、 nil値が代入される。
    
    パラメータ:
    portName - Port の名前
  - finalizePorts
```
public void finalizePorts()
```
    全ての Port をdeactivateし登録を削除する
    登録されている全てのPortに対して、サーバントのdeactivateを行い、登録リストから削除する。

クラス PortAdmin

ネストされたクラスのサマリー

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

メソッドのサマリー

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

コンストラクタの詳細

PortAdmin

メソッドの詳細

getPortList

getPortServiceList

activatePorts

deactivatePorts

getPortProfileList

getPortRef

getPort

addPort

addPort

registerPort

registerPort

removePort

removePort

deletePort

deletePort

deletePortByName

finalizePorts