クラス テンプレート RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >
オブジェクトリファレンスを保持するプレースホルダテンプレートクラス [詳細]
#include <CorbaConsumer.h>
Public メソッド | |
| CorbaConsumer () | |
| コンストラクタ | |
| CorbaConsumer (const CorbaConsumer &x) | |
| コピーコンストラクタ | |
| CorbaConsumer & | operator= (const CorbaConsumer &x) |
| 代入演算子 | |
| void | swap (CorbaConsumer &x) |
| virtual | ~CorbaConsumer (void) |
| 仮想デストラクタ | |
| virtual bool | setObject (CORBA::Object_ptr obj) |
| オブジェクトをセットする | |
| ObjectTypePtr | _ptr () |
| ObjectType 型のオブジェクトのリファレンスを取得. | |
| ObjectTypePtr | operator-> () |
| ObjectType 型のオブジェクトのリファレンスを取得. | |
| virtual void | releaseObject () |
| CORBAオブジェクトの設定をクリアする. | |
Protected 変数 | |
| ObjectTypeVar | m_var |
| 設定された CORBA オブジェクト | |
説明
template<class ObjectType, typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>
class RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >
オブジェクトリファレンスを保持するプレースホルダテンプレートクラス
テンプレート引数で与えられた型のCORBAオブジェクトを保持する。 オブジェクトがセットされたときに、与えられた型で narrow されるので、 _ptr() で取得するリファレンスは、narrow 済みのリファレンスである。 内部的な使用のために、_ptr 型, _var型も同時にテンプレート引数として 与える必要がある。(下記注意事項参照)
注意: ObjectTypePtr = ObjectType::_ptr_type としているか、 _ptr_type は標準では規定されていない。 ただし、omniORB, TAO, MICO では、プロキシクラス内部で、 Type_ptr 型を _ptr_type に typedef しているので、 テンプレートの第2引数を指定しなくてもコンパイルは通る。
- 引数:
-
ObjectType このホルダが保持するオブジェクトの型 ObjectTypePtr このホルダが保持する _ptr 型 ObjectTypeVar このホルダが保持する _var 型
- から:
- 0.4.0
コンストラクタとデストラクタ
| RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::CorbaConsumer | ( | ) | [inline] |
コンストラクタ
| RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::CorbaConsumer | ( | const CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & | x | ) | [inline] |
コピーコンストラクタ
- 引数:
-
x コピー元
| virtual RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::~CorbaConsumer | ( | void | ) | [inline, virtual] |
仮想デストラクタ
関数
| ObjectTypePtr RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::_ptr | ( | ) | [inline] |
ObjectType 型のオブジェクトのリファレンスを取得.
ObjectType に narrow済みのオブジェクトのリファレンスを取得する。 オブジェクトリファレンスを使用するには、setObject() でセット済みで なければならない。 オブジェクトがセットされていなければ nil オブジェクトリファレンスが 返される。
- 戻り値:
- ObjectType に narrow 済みのオブジェクトのリファレンス
| ObjectTypePtr RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::operator-> | ( | ) | [inline] |
ObjectType 型のオブジェクトのリファレンスを取得.
ObjectType に narrow済みのオブジェクトのリファレンスを取得する。 オブジェクトリファレンスを使用するには、setObject() でセット済みで なければならない。 オブジェクトがセットされていなければ nil オブジェクトリファレンスが 返される。
- 戻り値:
- ObjectType に narrow 済みのオブジェクトのリファレンス
| CorbaConsumer& RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::operator= | ( | const CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & | x | ) | [inline] |
代入演算子
- 引数:
-
x 代入元
- 戻り値:
- 代入結果
| virtual void RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject | ( | ) | [inline, virtual] |
CORBAオブジェクトの設定をクリアする.
設定されている CORBA オブジェクトをクリアする。 CORBAオブジェクトそのものに対しては何も操作しない。
RTC::CorbaConsumerBaseを再定義しています。
参照元 RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::releaseObject(), RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::setObject(), と RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::~CorbaConsumer().
| virtual bool RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject | ( | CORBA::Object_ptr | obj | ) | [inline, virtual] |
オブジェクトをセットする
ConsumerBase のオーバーライド。CORBAObject_var にオブジェクトをセット するとともに、templateパラメータの型で narrow したオブジェクトを メンバ変数に保持する。 _var 型変数を引数に渡す場合は var.in() を渡すこと。
- 引数:
-
[in] obj CORBA Objecct
- 戻り値:
- オブジェクト設定結果 設定対象オブジェクトが null の場合は false が返ってくる
RTC::CorbaConsumerBaseを再定義しています。
| void RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::swap | ( | CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & | x | ) | [inline] |
変数
ObjectTypeVar RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var [protected] |
設定された CORBA オブジェクト
参照元 RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::_ptr(), RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::operator->(), RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::releaseObject(), RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::setObject(), と RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >::swap().
