InPortProvider.py

説明を見る。
00001 #!/usr/bin/env python
00002 # -*- coding: euc-jp -*-
00003 
00004 ##
00005 # @file  InPortProvider.py
00006 # @brief InPortProvider class
00007 # @date  $Date: 2007/09/20 $
00008 # @author Noriaki Ando <n-ando@aist.go.jp> and Shinji Kurihara
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 import OpenRTM
00020 import SDOPackage, SDOPackage__POA
00021 
00022 
00023 ##
00024 # @if jp
00025 # @class InPortProvider
00026 # @brief InPortProvider クラス
00027 #
00028 # InPortの情報を保持するためのクラス。
00029 #
00030 # @since 0.4.0
00031 #
00032 # @else
00033 # @class InPortProvider
00034 # @brief InPortProvider class
00035 # @endif
00036 class InPortProvider:
00037   """
00038   """
00039 
00040 
00041 
00042   ##
00043   # @if jp
00044   # @brief コンストラクタ
00045   #
00046   # コンストラクタ
00047   #
00048   # @param self
00049   #
00050   # @else
00051   # @brief Constructor
00052   # @endif
00053   def __init__(self):
00054     self._properties = []
00055     self._dataType = ""
00056     self._interfaceType = ""
00057     self._dataflowType = ""
00058     self._subscriptionType = ""
00059 
00060 
00061   ##
00062   # @if jp
00063   # @brief InterfaceProfile情報を公開する
00064   #
00065   # InterfaceProfile情報を公開する。
00066   #
00067   # @param self
00068   # @param prop InterfaceProfile情報を受け取るプロパティ
00069   #
00070   # @else
00071   #
00072   # @endif
00073   def publishInterfaceProfile(self, prop):
00074     OpenRTM.NVUtil.appendStringValue(prop, "dataport.data_type",
00075              self._dataType)
00076     OpenRTM.NVUtil.appendStringValue(prop, "dataport.interface_type",
00077              self._interfaceType)
00078     OpenRTM.NVUtil.appendStringValue(prop, "dataport.dataflow_type",
00079              self._dataflowType)
00080     OpenRTM.NVUtil.appendStringValue(prop, "dataport.subscription_type",
00081              self._subscriptionType)
00082 
00083 
00084   ##
00085   # @if jp
00086   # @brief Interface情報を公開する
00087   #
00088   # Interface情報を公開する。
00089   #
00090   # @param self
00091   # @param prop Interface情報を受け取るプロパティ
00092   #
00093   # @else
00094   #
00095   # @endif
00096   def publishInterface(self, prop):
00097     if not OpenRTM.NVUtil.isStringValue(prop,
00098                 "dataport.interface_type",
00099                 self._interfaceType):
00100       return
00101 
00102     OpenRTM.NVUtil.append(prop, self._properties)
00103 
00104 
00105   ##
00106   # @if jp
00107   # @brief データタイプを設定する
00108   #
00109   # データタイプを設定する。
00110   #
00111   # @param self
00112   # @param data_type 設定対象データタイプ
00113   #
00114   # @else
00115   #
00116   # @endif
00117   def setDataType(self, data_type):
00118     self._dataType = data_type
00119 
00120 
00121   ##
00122   # @if jp
00123   # @brief インタフェースタイプを設定する
00124   #
00125   # インタフェースタイプを設定する。
00126   #
00127   # @param self
00128   # @param interface_type 設定対象インタフェースタイプ
00129   #
00130   # @else
00131   #
00132   # @endif
00133   def setInterfaceType(self, interface_type):
00134     self._interfaceType = interface_type
00135 
00136 
00137   ##
00138   # @if jp
00139   # @brief データフロータイプを設定する
00140   #
00141   # データフロータイプを設定する。
00142   #
00143   # @param self
00144   # @param dataflow_type 設定対象データフロータイプ
00145   #
00146   # @else
00147   #
00148   # @endif
00149   def setDataFlowType(self, dataflow_type):
00150     self._dataflowType = dataflow_type
00151 
00152 
00153   ##
00154   # @if jp
00155   # @brief サブスクリプションタイプを設定する
00156   #
00157   # サブスクリプションタイプを設定する。
00158   #
00159   # @param self
00160   # @param subs_type 設定対象サブスクリプションタイプ
00161   #
00162   # @else
00163   #
00164   # @endif
00165   def setSubscriptionType(self, subs_type):
00166     self._subscriptionType = subs_type

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