[openrtm-commit:02629] r3001 - trunk/OpenRTM-aist/src/lib/rtm
openrtm ＠ openrtm.org
openrtm ＠ openrtm.org
2017年 6月 12日 (月) 17:27:23 JST
Author: miyamoto
Date: 2017-06-12 17:27:23 +0900 (Mon, 12 Jun 2017)
New Revision: 3001
Modified:
trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.cpp
trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.h
Log:
[incompat, Choreonoid] add comment
Modified: trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.cpp
===================================================================
--- trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.cpp 2017-06-12 08:14:36 UTC (rev 3000)
+++ trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.cpp 2017-06-12 08:27:23 UTC (rev 3001)
@@ -1,17 +1,40 @@
-#include "SimulatorExecutionContext.h"
+// -*- C++ -*-
+/*!
+ * @file SimulatorExecutionContext.cpp
+ * @brief SimulatorExecutionContext class
+ * @date $Date$
+ * @author Nobuhiko Miyamoto <n-miyamoto at aist.go.jp>
+ *
+ * Copyright (C) 20017
+ * Nobuhiko Miyamoto
+ * Intelligent Systems Research Institute,
+ * National Institute of
+ * Advanced Industrial Science and Technology (AIST), Japan
+ * All rights reserved.
+ *
+ *
+ */
+
+
+#include "SimulatorExecutionContext.h"
#include <rtm/ECFactory.h>
-#ifdef OPENRTM_VERSION110
-#else
#include <rtm/RTObjectStateMachine.h>
-#endif
+
namespace RTC
{
- SimulatorExecutionContext::SimulatorExecutionContext()
+ /*!
+ * @if jp
+ * @brief コンストラクタ
+ * @else
+ * @brief Constructor
+ * @endif
+ */
+ SimulatorExecutionContext::SimulatorExecutionContext()
: RTC::OpenHRPExecutionContext()
{
@@ -19,7 +42,13 @@
}
-
+ /*!
+ * @if jp
+ * @brief デストラクタ
+ * @else
+ * @brief Destructor
+ * @endif
+ */
SimulatorExecutionContext::~SimulatorExecutionContext()
{
@@ -26,7 +55,28 @@
}
-
+ /*!
+ * @if jp
+ * @brief RTコンポーネントをアクティブ化する
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp アクティブ化対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for activation
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
RTC::ReturnCode_t SimulatorExecutionContext::
activate_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException)
@@ -56,6 +106,28 @@
}
+ /*!
+ * @if jp
+ * @brief RTコンポーネントを非アクティブ化する
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp 非アクティブ化対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for deactivate
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
RTC::ReturnCode_t SimulatorExecutionContext::
deactivate_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException)
@@ -86,6 +158,29 @@
}
+
+ /*!
+ * @if jp
+ * @brief RTコンポーネントをリセットする
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp リセット対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for reset
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
RTC::ReturnCode_t SimulatorExecutionContext::
reset_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException)
@@ -126,6 +221,13 @@
{
void SimulatorExecutionContextInit(RTC::Manager* manager)
{
+ /*!
+ * @if jp
+ * @brief ECFactoryへの登録のための初期化関数
+ * @else
+ * @brief Initialization function to register to ECFactory
+ * @endif
+ */
RTC::ExecutionContextFactory::
instance().addFactory("SimulatorExecutionContext",
::coil::Creator< ::RTC::ExecutionContextBase,
Modified: trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.h
===================================================================
--- trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.h 2017-06-12 08:14:36 UTC (rev 3000)
+++ trunk/OpenRTM-aist/src/lib/rtm/SimulatorExecutionContext.h 2017-06-12 08:27:23 UTC (rev 3001)
@@ -1,4 +1,22 @@
-#ifndef TEST_EC_H
+// -*- C++ -*-
+/*!
+ * @file SimulatorExecutionContext.h
+ * @brief Execution context for Choreonoid
+ * @date $Date: 2017-06-12 07:49:59 $
+ * @author Nobuhiko Miyamoto <n-miyamoto at aist.go.jp>
+ *
+ * Copyright (C) 2017
+ * Nobuhiko Miyamoto
+ * Intelligent Systems Research Institute,
+ * National Institute of
+ * Advanced Industrial Science and Technology (AIST), Japan
+ * All rights reserved.
+ *
+ *
+ */
+
+
+#ifndef TEST_EC_H
#define TEST_EC_H
@@ -12,6 +30,23 @@
namespace RTC
{
+ /*!
+ * @if jp
+ * @class SimulatorExecutionContext
+ * @brief SimulatorExecutionContext クラス
+ *
+ * Choreonoidのための実行コンテキスト。外部からの tick() 呼び出しにより、1周期
+ * 分だけ処理を進めることができる。
+ *
+ * @else
+ * @class SimulatorExecutionContext
+ * @brief SimulatorExecutionContext class
+ *
+ *
+ *
+ *
+ * @endif
+ */
class SimulatorExecutionContext
: public virtual RTC::OpenHRPExecutionContext
{
@@ -18,15 +53,95 @@
typedef coil::Mutex Mutex;
typedef coil::Guard<coil::Mutex> Guard;
public:
+ /*!
+ * @if jp
+ * @brief コンストラクタ
+ * @else
+ * @brief Constructor
+ * @endif
+ */
SimulatorExecutionContext();
+ /*!
+ * @if jp
+ * @brief デストラクタ
+ * @else
+ * @brief Destructor
+ * @endif
+ */
virtual ~SimulatorExecutionContext(void);
+ /*!
+ * @if jp
+ * @brief RTコンポーネントをアクティブ化する
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp アクティブ化対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for activation
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
virtual RTC::ReturnCode_t
activate_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException);
+ /*!
+ * @if jp
+ * @brief RTコンポーネントを非アクティブ化する
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp 非アクティブ化対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for deactivate
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
virtual RTC::ReturnCode_t
deactivate_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException);
+ /*!
+ * @if jp
+ * @brief RTコンポーネントをリセットする
+ *
+ * 内部でinvokeWorkerPreDo関数を呼ぶため、即座に
+ * 状態を遷移させることができる。
+ * 現在tick実行中の場合は実行終了まで待つ
+ *
+ * @param comp リセット対象RTコンポーネント
+ *
+ * @return ReturnCode_t 型のリターンコード
+ *
+ * @else
+ *
+ * @brief Activate an RT-component
+ *
+ * @param comp The target RT-Component for reset
+ *
+ * @return The return code of ReturnCode_t type
+ *
+ * @endif
+ */
virtual RTC::ReturnCode_t
reset_component(RTC::LightweightRTObject_ptr comp)
throw (CORBA::SystemException);
@@ -44,6 +159,13 @@
extern "C"
{
+ /*!
+ * @if jp
+ * @brief ECFactoryへの登録のための初期化関数
+ * @else
+ * @brief Initialization function to register to ECFactory
+ * @endif
+ */
DLL_EXPORT void SimulatorExecutionContextInit(RTC::Manager* manager);
};
More information about the openrtm-commit
mailing list