00001 #!/usr/bin/env python 00002 # -*- coding: euc-jp -*- 00003 00004 ## 00005 # @file ConnectorBase.py 00006 # @brief Connector base class 00007 # @date $Date$ 00008 # @author Noriaki Ando <n-ando@aist.go.jp> and Shinji Kurihara 00009 # 00010 # Copyright (C) 2009 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_aist 00019 00020 00021 ## 00022 # @if jp 00023 # @class ConnectorInfo クラス 00024 # @brief ConnectorInfo クラス 00025 # 00026 # @class ConnectorInfo class 00027 # @brief ConnectorInfo class 00028 # 00029 # @endif 00030 # 00031 class ConnectorInfo: 00032 """ 00033 """ 00034 ## 00035 # @if jp 00036 # 00037 # @brief コンストラクタ 00038 # 00039 # コンストラクタ 00040 # 00041 # @param name_ 接続名前 00042 # @param id_ 接続ID 00043 # @param ports_ 接続ポートIOR 00044 # @param properties_ プロパティ 00045 # 00046 # @else 00047 # 00048 # @brief Constructor 00049 # 00050 # Constructor 00051 # 00052 # @param name_ connection name 00053 # @param id_ connection ID 00054 # @param ports_ connection Ports 00055 # @param properties_ connection properties 00056 # 00057 # @endif 00058 # ConnectorInfo(const char* name_, const char* id_, 00059 # coil::vstring ports_, coil::Properties properties_) 00060 def __init__(self, name_, id_, ports_, properties_): 00061 self.name = name_ # str 00062 self.id = id_ # str 00063 self.ports = ports_ # [str,...] 00064 self.properties = properties_ # OpenRTM_aist.Properties 00065 00066 #! 00067 # @if jp 00068 # @class ConnectorBase 00069 # @brief Connector 基底クラス 00070 # 00071 # InPort/OutPort, Push/Pull 各種 Connector を派生させるための 00072 # 基底クラス。 00073 # 00074 # @since 1.0.0 00075 # 00076 # @else 00077 # @class ConnectorBase 00078 # @brief Connector Base class 00079 # 00080 # The base class to derive subclasses for InPort/OutPort, 00081 # Push/Pull Connectors 00082 # 00083 # @since 1.0.0 00084 # 00085 # @endif 00086 class ConnectorBase(OpenRTM_aist.DataPortStatus): 00087 """ 00088 """ 00089 00090 ## 00091 # @if jp 00092 # @class Profile 00093 # @brief Connector profile ローカル構造体 00094 # 00095 # ConnectorBase およびその派生クラスで扱う ConnectorProfile 構造体。 00096 # 00097 # @since 1.0.0 00098 # 00099 # @else 00100 # @class Profile 00101 # @brief local representation of Connector profile 00102 # 00103 # ConnectorProfile struct for ConnectorBase and its subclasses. 00104 # 00105 # @since 1.0.0 00106 # 00107 # @endif 00108 00109 ## 00110 # @if jp 00111 # @brief デストラクタ 00112 # @else 00113 # @brief Destructor 00114 # @endif 00115 def __del__(self): 00116 pass 00117 00118 00119 ## 00120 # @if jp 00121 # @brief Profile 取得 00122 # 00123 # Connector Profile を取得する 00124 # 00125 # @else 00126 # @brief Getting Profile 00127 # 00128 # This operation returns Connector Profile 00129 # 00130 # @endif 00131 # virtual const ConnectorInfo& profile() = 0; 00132 def profile(self): 00133 pass 00134 00135 ## 00136 # @if jp 00137 # @brief Connector ID 取得 00138 # 00139 # Connector ID を取得する 00140 # 00141 # @else 00142 # @brief Getting Connector ID 00143 # 00144 # This operation returns Connector ID 00145 # 00146 # @endif 00147 # virtual const char* id() = 0; 00148 def id(self): 00149 pass 00150 00151 00152 ## 00153 # @if jp 00154 # @brief Connector 名取得 00155 # 00156 # Connector 名を取得する 00157 # 00158 # @else 00159 # @brief Getting Connector name 00160 # 00161 # This operation returns Connector name 00162 # 00163 # @endif 00164 # virtual const char* name() = 0; 00165 def name(self): 00166 pass 00167 00168 00169 ## 00170 # @if jp 00171 # @brief 接続解除関数 00172 # 00173 # Connector が保持している接続を解除する 00174 # 00175 # @else 00176 # @brief Disconnect connection 00177 # 00178 # This operation disconnect this connection 00179 # 00180 # @endif 00181 # virtual ReturnCode disconnect() = 0; 00182 def disconnect(self): 00183 pass 00184 00185 00186 ## 00187 # @if jp 00188 # @brief Buffer を取得する 00189 # 00190 # Connector が保持している Buffer を返す 00191 # 00192 # @else 00193 # @brief Getting Buffer 00194 # 00195 # This operation returns this connector's buffer 00196 # 00197 # @endif 00198 # virtual CdrBufferBase* getBuffer() = 0; 00199 def getBuffer(self): 00200 pass 00201 00202 00203 ## 00204 # @if jp 00205 # @brief アクティブ化 00206 # 00207 # このコネクタをアクティブ化する 00208 # 00209 # @else 00210 # 00211 # @brief Connector activation 00212 # 00213 # This operation activates this connector 00214 # 00215 # @endif 00216 # virtual void activate() = 0; 00217 def activate(self): 00218 pass 00219 00220 00221 ## 00222 # @if jp 00223 # @brief 非アクティブ化 00224 # 00225 # このコネクタを非アクティブ化する 00226 # 00227 # @else 00228 # 00229 # @brief Connector deactivation 00230 # 00231 # This operation deactivates this connector 00232 # 00233 # @endif 00234 # virtual void deactivate() = 0; 00235 def deactivate(self): 00236 pass