00001 #!/usr/bin/env python 00002 # -*- coding: euc-jp -*- 00003 00004 00005 ## 00006 # @file InPortConsumer.py 00007 # @brief InPortConsumer class 00008 # @date $Date: 2007/09/04$ 00009 # @author Noriaki Ando <n-ando@aist.go.jp> 00010 # 00011 # Copyright (C) 2006-2008 00012 # Noriaki Ando 00013 # Task-intelligence Research Group, 00014 # Intelligent Systems Research Institute, 00015 # National Institute of 00016 # Advanced Industrial Science and Technology (AIST), Japan 00017 # All rights reserved. 00018 00019 00020 import OpenRTM 00021 00022 ## 00023 # @if jp 00024 # 00025 # @class InPortConsumer 00026 # 00027 # @brief InPortConsumer 基底クラス 00028 # 00029 # 入力ポートコンシューマのための抽象インターフェースクラス 00030 # 各具象クラスは、以下の関数の実装を提供しなければならない。 00031 # - push(): データ送信 00032 # - clone(): ポートのコピー 00033 # - subscribeInterface(): データ送出通知への登録 00034 # - unsubscribeInterface(): データ送出通知の登録解除 00035 # 00036 # @since 0.4.0 00037 # 00038 # @else 00039 # @class InPortConsumer 00040 # @brief InPortConsumer class 00041 # @endif 00042 class InPortConsumer: 00043 """ 00044 """ 00045 00046 00047 00048 ## 00049 # @if jp 00050 # @brief 接続先へのデータ送信(サブクラス実装用) 00051 # 00052 # 接続先のポートへデータを送信するための関数。<BR> 00053 # ※サブクラスでの実装参照用 00054 # 00055 # @param self 00056 # 00057 # @else 00058 # 00059 # @endif 00060 def push(self): 00061 pass 00062 00063 ## 00064 # @if jp 00065 # @brief 当該ポートのコピー(サブクラス実装用) 00066 # 00067 # 当該ポートのコピーを生成するための関数。 00068 # ※サブクラスでの実装参照用 00069 # 00070 # @param self 00071 # 00072 # @return 複製された InPortConsumer オブジェクト 00073 # 00074 # @else 00075 # 00076 # @endif 00077 def clone(self): 00078 pass 00079 00080 00081 ## 00082 # @if jp 00083 # @brief データ送出通知受け取りへの登録(サブクラス実装用) 00084 # 00085 # 指定されたプロパティの内容に基づいて、データ送出通知の受け取りに登録する 00086 # ための関数。 00087 # ※サブクラスでの実装参照用 00088 # 00089 # @param self 00090 # @param properties 登録時に参照するプロパティ 00091 # 00092 # @return 登録処理結果 00093 # 00094 # @else 00095 # 00096 # @endif 00097 def subscribeInterface(self, properties): 00098 pass 00099 00100 00101 ## 00102 # @if jp 00103 # @brief データ送出通知受け取りからの登録解除(サブクラス実装用) 00104 # 00105 # データ送出通知の受け取りから登録解除するための関数。 00106 # ※サブクラスでの実装参照用 00107 # 00108 # @param self 00109 # @param properties 登録解除時に参照するプロパティ 00110 # 00111 # @else 00112 # 00113 # @endif 00114 def unsubscribeInterface(self, properties): 00115 pass