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