クラス OutPort

OutPort クラス [詳細]


Public メソッド

def __init__
 コンストラクタ
def isNew
 最新データか確認
def write
 データ書き込み
def read
 データ読み出し
def setReadBlock
 データ読み出し処理のブロックモードの設定
def setWriteBlock
 データ書き込み処理のブロックモードの設定
def setReadTimeout
 読み出し処理のタイムアウト時間の設定
def setWriteTimeout
 書き込み処理のタイムアウト時間の設定
def setOnWrite
 OnWrite コールバックの設定
def setOnWriteConvert
 OnWriteConvert コールバックの設定
def setOnOverflow
 OnOverflow コールバックの設定
def setOnRead
 OnRead コールバックの設定
def setOnReadConvert
 OnReadConvert コールバックの設定
def setOnUnderflow
 OnUnderflow コールバックの設定
def getPortDataType
 データ型名取得用メソッド


説明

OutPort クラス

OutPort 用クラス

から:
0.2.0

OutPort.py91 行で定義されています。


関数

def __init__ (   self,
  name,
  value,
  buffer_ 
)

コンストラクタ

コンストラクタ

引数:
self 
name ポート名
value このポートにバインドされるデータ変数
buffer_ バッファ

OutPort.py114 行で定義されています。

def isNew (   self  ) 

最新データか確認

現在のバッファ位置に格納されているデータが最新データか確認する。

引数:
self 
戻り値:
最新データ確認結果 ( true:最新データ.データはまだ読み出されていない false:過去のデータ.データは既に読み出されている)

OutPort.py146 行で定義されています。

def write (   self,
  value = None 
)

データ書き込み

ポートへデータを書き込む。

引数:
self 
value 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)
virtual bool write(const DataType& value)

データ書き込み

ポートへデータを書き込む。 設定された値をポートに書き込む。

引数:
self 
value 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)
bool operator<<(DataType& value)

OutPort.py194 行で定義されています。

def read (   self,
  value 
)

データ読み出し

DataPort から値を読み出す

引数:
self 
value 読み出したデータ
戻り値:
読み出し処理実行結果(読み出し成功:true、読み出し失敗:false)

OutPort.py272 行で定義されています。

def setReadBlock (   self,
  block 
)

データ読み出し処理のブロックモードの設定

読み出し処理に対してブロックモードを設定する。 ブロックモードを指定した場合、読み出せるデータを受信するかタイムアウト が発生するまで、 read() メソッドの呼びだしがブロックされる。

引数:
self 
block ブロックモードフラグ

OutPort.py331 行で定義されています。

def setWriteBlock (   self,
  block 
)

データ書き込み処理のブロックモードの設定

書き込み処理に対してブロックモードを設定する。 ブロックモードを指定した場合、バッファに書き込む領域ができるか タイムアウトが発生するまで write() メソッドの呼びだしがブロックされる。

引数:
self 
block ブロックモードフラグ

OutPort.py352 行で定義されています。

def setReadTimeout (   self,
  timeout 
)

読み出し処理のタイムアウト時間の設定

read() のタイムアウト時間を usec で設定する。 read() はブロックモードでなければならない。

引数:
self 
timeout タイムアウト時間 [usec]

OutPort.py372 行で定義されています。

def setWriteTimeout (   self,
  timeout 
)

書き込み処理のタイムアウト時間の設定

write() のタイムアウト時間を usec で設定する。 write() はブロックモードでなければならない。

引数:
self 
timeout タイムアウト時間 [usec]

OutPort.py392 行で定義されています。

def setOnWrite (   self,
  on_write 
)

OnWrite コールバックの設定

データ書き込み直前に呼ばれる OnWrite コールバックファンクタを設定する。

引数:
self 
on_write OnWrite コールバックファンクタ

OutPort.py411 行で定義されています。

def setOnWriteConvert (   self,
  on_wconvert 
)

OnWriteConvert コールバックの設定

データ書き込み時に呼ばれる OnWriteConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が書き込まれる。 このため書き込みデータのフィルタリングが可能となる。

引数:
self 
on_wconvert OnWriteConvert コールバックファンクタ

OutPort.py433 行で定義されています。

def setOnOverflow (   self,
  on_overflow 
)

OnOverflow コールバックの設定

バッファフルによりデータ書き込みができない場合に呼び出される OnOverflow コールバックファンクタを設定する。

引数:
self 
on_overflow OnOverflow コールバックファンクタ

OutPort.py453 行で定義されています。

def setOnRead (   self,
  on_read 
)

OnRead コールバックの設定

データ読み出し直前に呼び出される OnRead コールバックファンクタを設定 する。

引数:
self 
on_read OnRead コールバックファンクタ

OutPort.py473 行で定義されています。

def setOnReadConvert (   self,
  on_rconvert 
)

OnReadConvert コールバックの設定

データ読み出し時に呼ばれる OnReadConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が読み込まれる。 このため読み込みデータのフィルタリングが可能となる。

引数:
self 
on_rconvert OnReadConvert コールバックファンクタ

OutPort.py495 行で定義されています。

def setOnUnderflow (   self,
  on_underflow 
)

OnUnderflow コールバックの設定

バッファエンプティにより読み出せるデータがない場合に呼び出される コールバックファンクタ OnUnderflow を設定する。

引数:
self 
on_underflow OnUnderflow コールバックファンクタ

OutPort.py515 行で定義されています。

def getPortDataType (   self  ) 

データ型名取得用メソッド

データの型名を取得するため、InPortCorbaProviderから呼ばれる。

引数:
self 
戻り値:
バッファに設定されているデータの型名

OutPort.py533 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:07 2008に生成されました。  doxygen 1.5.4