OpenRTM-aist-Python 2.0.0
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.CSPManager.CSPManager クラス

[詳解]

OpenRTM_aist.CSPManager.CSPManager の継承関係図

クラス

class  CSPThreadCtrl
 

公開メンバ関数

def __init__ (self)
 
def __del__ (self)
 
def reset (self)
 
def selectOutPort (self)
 
def selectInPort (self)
 
def getPorts (self)
 
def selectPort (self, ports)
 
def reselectPort (self, ports)
 
def select (self, timeout)
 
def notify (self, outport=None, inport=None)
 
def addInPort (self, port)
 
def addOutPort (self, port)
 
def removeInPort (self, port)
 
def removeOutPort (self, port)
 

詳解

CSPOutPort、CSPInPortを管理するクラス

から
2.0.0

構築子と解体子

◆ __init__()

def OpenRTM_aist.CSPManager.CSPManager.__init__ (   self)

コンストラクタ

引数
self

◆ __del__()

def OpenRTM_aist.CSPManager.CSPManager.__del__ (   self)

デストラクタ

デストラクタ。

メソッド詳解

◆ addInPort()

def OpenRTM_aist.CSPManager.CSPManager.addInPort (   self,
  port 
)

InPortを追加

引数
self
portInPort

◆ addOutPort()

def OpenRTM_aist.CSPManager.CSPManager.addOutPort (   self,
  port 
)

OutPortを追加

引数
self
portOutPort

◆ getPorts()

def OpenRTM_aist.CSPManager.CSPManager.getPorts (   self)

ポートをロックモードと非ロックモードに仕分けする

引数
self
戻り値
ports1, ports2 ports1:ロックモードのポート ports2:非ロックモードのポート

◆ notify()

def OpenRTM_aist.CSPManager.CSPManager.notify (   self,
  outport = None,
  inport = None 
)

待機状態解除を通知 select関数で待機している場合に、待機を解除する

引数
self
戻り値
True:待機状態を解除、False:待機状態ではない

◆ removeInPort()

def OpenRTM_aist.CSPManager.CSPManager.removeInPort (   self,
  port 
)

InPortを削除

引数
self
portInPort

◆ removeOutPort()

def OpenRTM_aist.CSPManager.CSPManager.removeOutPort (   self,
  port 
)

Outortを削除

引数
self
portOutPort

◆ reselectPort()

def OpenRTM_aist.CSPManager.CSPManager.reselectPort (   self,
  ports 
)

ポート一覧から通信可能なポートを再選択する

引数
self
ports選択対象のポート一覧
戻り値
ret, outport, inport ret:True:選択成功、False:選択失敗 outport:選択したOutPort。OutPortを選択しなかった場合はNone inport:選択したInPort。InPortを選択しなかった場合はNone

◆ reset()

def OpenRTM_aist.CSPManager.CSPManager.reset (   self)

CSPポートに設定したCSPManagerとの関連付けを解除

引数
self

◆ select()

def OpenRTM_aist.CSPManager.CSPManager.select (   self,
  timeout 
)

読み込み可能なInPort、もしくは書き込み可能なOutPortを選択する 読み込み可能なInPort、書き込み可能なOutPortが存在しない場合はタイムアウトまで待機する 待機解除後、読み込み可能なInPort、もしくは書き込み可能なOutPortを再度選択する

引数
self
timeout待機のタイムアウト時間
戻り値
ret, outport, inport ret:Ture(書き込み、読み込み可能なポートが存在)、False(タイムアウト) outport:OutPortを選択した場合に、書き込み可能なOutPortを格納 inport:InPortを選択した場合に、読み込み可能なInortを格納

◆ selectInPort()

def OpenRTM_aist.CSPManager.CSPManager.selectInPort (   self)

読み込み可能なInPortを選択する

引数
self
戻り値
ret, port ret:True(読み込み可能なInPortが存在する)、False(存在しない) port:読み込み可能なInPort。選択できなかった場合はNone

◆ selectOutPort()

def OpenRTM_aist.CSPManager.CSPManager.selectOutPort (   self)

書き込み可能なOutPortを選択する

引数
self
戻り値
ret, port ret:True(書き込み可能なOutPortが存在する)、False(存在しない) port:書き込み可能なOutPort。選択できなかった場合はNone

◆ selectPort()

def OpenRTM_aist.CSPManager.CSPManager.selectPort (   self,
  ports 
)

ポート一覧から通信可能なポートを自動選択する

引数
self
ports選択対象のポート一覧
戻り値
ret, outport, inport ret:True:選択成功、False:選択失敗 outport:選択したOutPort。OutPortを選択しなかった場合はNone inport:選択したInPort。InPortを選択しなかった場合はNone

このクラス詳解は次のファイルから抽出されました: