PublisherBase.py

説明を見る。
00001 #!/usr/bin/env python 
00002 # -*- coding: euc-jp -*-
00003 
00004 ##
00005 # @file PublisherBase.py
00006 # @brief Publisher base class
00007 # @date $Date: 2007/09/05$
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 
00019 ##
00020 # @if jp
00021 #
00022 # @class PublisherBase
00023 #
00024 # @brief Publisher 基底クラス
00025 # 
00026 # データ送出タイミングを管理して送出を駆動するPublisher* の基底クラス。
00027 # 各種 Publisher はこのクラスを継承して詳細を実装する。
00028 #
00029 # @since 0.4.0
00030 #
00031 # @else
00032 #
00033 # @class PublisherBase
00034 #
00035 # @brief Base class of Publisher.
00036 #
00037 # A base class of Publisher*.
00038 # Variation of Publisher* which implements details of Publisher
00039 # inherits this PublisherBase class.
00040 #
00041 # @endif
00042 class PublisherBase:
00043   """
00044   """
00045 
00046 
00047 
00048   ##
00049   # @if jp
00050   #
00051   # @brief 送出タイミングを通知する。(サブクラス実装用)
00052   #
00053   # 送出を待つオブジェクトに、送出タイミングを通知するための関数。<BR>
00054   # ※サブクラスでの実装参照用
00055   # 
00056   # @param self
00057   # 
00058   # @else
00059   #
00060   # @endif
00061   def update(self):
00062     pass
00063 
00064 
00065   ##
00066   # @if jp
00067   #
00068   # @brief Publisher を破棄する。(サブクラス実装用)
00069   #
00070   # 当該 Publisher を破棄する。
00071   # 当該 Publisher が不要になった場合に PublisherFactory から呼び出される。<BR>
00072   # ※サブクラスでの実装参照用
00073   # 
00074   # @param self
00075   #
00076   # @else
00077   #
00078   # @endif
00079   def release(self):
00080     pass

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