つくばチャレンジ２００８プログラム Robot Design and Control Lab urg

(1)

リファレンスマニュアル

作成： Doxygen 1.5.5

Fri Mar 6 22:57:57 2009

(2)

(3)

URG ^{センサコンポーネント}

URG^センサ(^北陽電機TopURG, HighURG)により周囲の距離を取得するコンポーネントです。つくばチャレンジ用に作成したプログラムです。

バグが残っていると思いますが、何かの役に立てばと思い公開します。

注意_:

このプログラムによって発生した損害は補償しません。あくまでもサンプルとお考えください。

日付_:

2008.03.03 作者_:

Chiba Institute of Technology

(6)

(7)

Chapter 2 構成索引

2.1 ^構成

クラス、構造体、共用体、インタフェースの説明です。

CSerial (シリアル通信（テキスト）を行うクラス) . . . 7 urg(URGセンサのデータを取得するコンポーネント) . . . 11

(8)

(9)

Chapter 3 ファイル索引

3.1 ^{ファイル一覧}

これはファイル一覧です。

serial.cpp(シリアル通信（テキスト）を行うクラス) . . . 15

serial.h(シリアル通信（テキスト）を行うクラス) . . . 16

urg.cpp(URGセンサからデータを取得するためのクラス) . . . 17

urg.h(URGセンサからデータを取得するためのコンポーネント) . . . 19

urgComp.cpp(URGのデータを取得するコンポーネント) . . . 20

(10)

(11)

Chapter 4 クラス

4.1 ^クラス CSerial

シリアル通信（テキスト）を行うクラス

#include <serial.h>

Public ^メソッド

CSerial () コンストラクタ

∼CSerial() デストラクタ

FILE ∗getDevice () デバイスの取得

intgetBaudRate() ボーレートの取得

char ∗ getPortName() ポート名の取得

intOpen(const char ∗port_name, int aSpeed) シリアル通信デバイスをオープンする

intClose()

シリアル通信デバイスをクローズする

intSend(const char ∗data, unsigned int len) テキストデータを送信する

(12)

8 ^クラス

intRecv(char ∗data, int max_len) テキストデータを受信する

intClearRecvBuf()

バッファに溜まったデータをクリアする

speed_tbitrate(int aBR)

ビットレートを定数に変換する関数

4.1.1 ^説明

4.1.2 コンストラクタとデストラクタ

4.1.2.1 CSerial::CSerial ()

コンストラクタ

デバイスとボーレートの初期化

戻り値_: 無し

4.1.2.2 CSerial::∼CSerial ()

デストラクタ

4.1.3 ^関数

4.1.3.1 FILE∗ CSerial::getDevice () [inline]

デバイスの取得

戻り値_:

デバイスのポインタ

Fri Mar 6 22:57:57 2009^{に生成されました。}Doxygen

(13)

4.1 ^クラス CSerial 9 4.1.3.2 int CSerial::getBaudRate () [inline]

ボーレートの取得

戻り値_:

ボーレート

4.1.3.3 char∗ CSerial::getPortName () [inline]

ポート名の取得

戻り値_:

ポート名のポインタ

4.1.3.4 int CSerial::Open (const char ∗ port_name, int aSpeed)

シリアル通信デバイスをオープンするデバイスとボーレートの初期化

引数_:

← port_name ポートの名称

← aSpeed ボーレート

戻り値_:

1:^成功0:^失敗

4.1.3.5 int CSerial::Close ()

シリアル通信デバイスをクローズする

戻り値_: 1

4.1.3.6 int CSerial::Send (const char ∗ data, unsigned int len) テキストデータを送信する

(14)

10 ^クラス

引数_:

← data 送信するデータのポインタ

← len データのバイト数

戻り値_:

送信したデータのバイト数_(0:失敗₎

4.1.3.7 int CSerial::Recv (char ∗ data, int max_len)

テキストデータを受信する

引数_:

→ data 受信するデータのポインタ

← max_len データのバイト数の最大値

戻り値_:

受信したデータの文字数_(-1:失敗₎

4.1.3.8 int CSerial::ClearRecvBuf (void)

バッファに溜まったデータをクリアする

戻り値_: 1

4.1.3.9 speed_t CSerial::bitrate (int aBR) [inline]

ビットレートを定数に変換する関数

引数_:

← aBR ボーレート

戻り値_:

ボーレートの定数

このクラスの説明は次のファイルから生成されました_:

serial.h

serial.cpp

(15)

4.2 ^クラス urg 11

4.2 ^クラス urg

URGセンサのデータを取得するコンポーネント

#include <urg.h>

Public ^メソッド

urg(RTC::Manager ∗manager)

∼urg ()

virtual RTC::ReturnCode_t onInitialize() URG^{センサの初期化}

virtual RTC::ReturnCode_t onFinalize() コンポーネントを終了するときに呼び出される関数

virtual RTC::ReturnCode_t onActivated(RTC::UniqueId ec_id) コンポーネントをアクティベートするときに呼ばれる関数

virtual RTC::ReturnCode_t onDeactivated(RTC::UniqueId ec_id) コンポーネントをデアクティベートするときに呼ばれる関数

virtual RTC::ReturnCode_t onExecute(RTC::UniqueId ec_id) アクティベート中に定期的に呼ばれる関数

Protected ^変数

std::stringm_devName シリアル通信のデバイス名

unsigned shortm_type

URG^のタイプ(1:TopURG,2:HighURG)

TimedShortSeqm_urgData

URGのデータ配列（コンポーネント出力）

OutPort< TimedShortSeq >m_urgDataOut

4.2.1 ^説明

4.2.2 コンストラクタとデストラクタ

(16)

12 ^クラス 4.2.2.1 urg::urg (RTC::Manager ∗ manager)

4.2.2.2 urg::∼urg ()

4.2.3 ^関数

4.2.3.1 RTC::ReturnCode_t urg::onInitialize () [virtual] URG^{センサの初期化}

オープンするデバイスを設定コンポーネントの出力の設定

戻り値_: RTC_OK

4.2.3.2 RTC::ReturnCode_t urg::onFinalize () [virtual]

コンポーネントを終了するときに呼び出される関数シリアル通信デバイスをクローズする

戻り値_: RTC_OK

4.2.3.3 RTC::ReturnCode_t urg::onActivated (RTC::UniqueId ec_id) [virtual] コンポーネントをアクティベートするときに呼ばれる関数

URGのタイプに応じて出力データサイズを設定する

シリアル通信デバイスをオープンするデータの受信領域を確保する

また、_GPSセンサに初期化のデータを送信する戻り値_:

RTC_OK:^成功、RTC_ERROR:^失敗

(17)

4.2 ^クラス urg 13

4.2.3.4 RTC::ReturnCode_t urg::onDeactivated (RTC::UniqueId ec_id) [virtual]

コンポーネントをデアクティベートするときに呼ばれる関数データの受信領域を開放する

戻り値_: RTC_OK

4.2.3.5 RTC::ReturnCode_t urg::onExecute (RTC::UniqueId ec_id) [virtual]

アクティベート中に定期的に呼ばれる関数 URG^{のデータを受信}

データを距離に変更した後、コンポーネントの出力に送る

引数_:

→ m_urgData 距離データの配列

戻り値_: RTC_OK

4.2.4 ^変数

4.2.4.1 std::string urg::m_devName [protected] シリアル通信のデバイス名

4.2.4.2 unsigned short urg::m_type [protected] URG^のタイプ(1:TopURG,2:HighURG)

4.2.4.3 TimedShortSeq urg::m_urgData [protected] URGのデータ配列（コンポーネント出力）

(18)

14 ^クラス 4.2.4.4 OutPort<TimedShortSeq> urg::m_urgDataOut [protected]

このクラスの説明は次のファイルから生成されました_:

urg.h

urg.cpp

(19)

Chapter 5 ファイル

5.1 serial.cpp

#include "serial.h"

5.1.1 ^説明

日付_:

2008.03.03

(20)

16 ^ファイル

5.2 serial.h

#include <stdio.h>

#include <string.h>

#include <stdlib.h>

#include <sys/termios.h>

#include <unistd.h>

構成

classCSerial

5.2.1 ^説明

日付_:

2008.03.03

(21)

5.3 urg.cpp 17

5.3 urg.cpp

URGセンサからデータを取得するためのクラス

#include "urg.h"

マクロ定義

#deneMAX_DATA_11081 TopURG^{の取得データ数}

#deneMAX_DATA_2769 HighURG^{の取得データ数}

関数

void urgInit(RTC::Manager ∗manager)

5.3.1 ^説明

URGセンサからデータを取得するためのクラス

日付_:

2008.03.03

作者_:

T.Hayashi Y.Hayashibara

5.3.2 ^{マクロ定義}

5.3.2.1 #dene MAX_DATA_1 1081 TopURG^{の取得データ数}

5.3.2.2 #dene MAX_DATA_2 769 HighURG^{の取得データ数}

(22)

18 ^ファイル

5.3.3 ^関数

5.3.3.1 void urgInit (RTC::Manager ∗ manager)

(23)

5.4 urg.h 19

5.4 urg.h

URGセンサからデータを取得するためのコンポーネント

#include <rtm/Manager.h>

#include <rtm/DataFlowComponentBase.h>

#include <rtm/CorbaPort.h>

#include <rtm/DataInPort.h>

#include <rtm/DataOutPort.h>

#include <rtm/idl/BasicDataTypeSkel.h>

#include "serial.h"

構成

classurg

関数

void urgInit(RTC::Manager ∗manager)

5.4.1 ^説明

URGセンサからデータを取得するためのコンポーネント

日付_:

2008.03.03

作者_:

5.4.2 ^関数

5.4.2.1 void urgInit (RTC::Manager ∗ manager)

(24)

20 ^ファイル

5.5 urgComp.cpp

URGのデータを取得するコンポーネント

#include <rtm/Manager.h>

#include <iostream>

#include <string>

#include <stdlib.h>

#include "urg.h"

関数

void MyModuleInit(RTC::Manager ∗manager)

intmain (int argc, char ∗∗argv)

5.5.1 ^説明

URGのデータを取得するコンポーネント

日付_:

2008.03.03

作者_:

5.5.2 ^関数

5.5.2.1 int main (int argc, char ∗∗ argv)

5.5.2.2 void MyModuleInit (RTC::Manager ∗ manager)

(25)

Index

∼CSerial CSerial,8

∼urgurg,12 bitrate

CSerial,10 ClearRecvBuf

CSerial,10 Close

CSerial,9 CSerial,7

∼CSerial,8 bitrate,10 ClearRecvBuf,10 Close,9

CSerial,8 getBaudRate,8 getDevice,8 getPortName,9 Open,9

Recv,10 Send,9 getBaudRate

CSerial,8 getDevice

CSerial,8 getPortName

CSerial,9 m_devName

urg,13 m_type

urg,13 m_urgData urg,13 m_urgDataOut

urg,13

mainurgComp.cpp,20 MAX_DATA_1

urg.cpp,17 MAX_DATA_2

urg.cpp,17

MyModuleInit urgComp.cpp,20 onActivated

urg,12 onDeactivated

urg,12 onExecute

urg,13 onFinalize

urg,12 onInitialize urg,12 OpenCSerial,9 RecvCSerial,10

SendCSerial,9 serial.cpp,15 serial.h,16 urg,11

∼urg,12

m_devName,13 m_type,13 m_urgData,13 m_urgDataOut,13 onActivated,12 onDeactivated,12 onExecute,13 onFinalize,12 onInitialize,12 urg,11

urg.cpp,17

MAX_DATA_1,17 MAX_DATA_2,17 urgInit,18

urg.h,19 urgInit,19 urgComp.cpp,20

main,20

MyModuleInit,20 urgInit

(26)

22 INDEX

urg.cpp,18 urg.h,19

つくばチャレンジ２００８プログラム Robot Design and Control Lab urg

リファレンスマニュアル

作成： Doxygen 1.5.5

Contents

Chapter 1

URG センサコンポーネント

Chapter 2

構成索引

2.1 構成

Chapter 3

ファイル索引

3.1 ファイル一覧

Chapter 4

クラス

4.1 クラス CSerial

Public メソッド

4.1.1 説明

4.1.2 コンストラクタとデストラクタ

4.1.3 関数

4.2 クラス urg

Public メソッド

Protected 変数

4.2.1 説明

4.2.2 コンストラクタとデストラクタ

4.2.3 関数

4.2.4 変数

Chapter 5

ファイル

5.1 serial.cpp

5.1.1 説明

5.2 serial.h

構成

5.2.1 説明

5.3 urg.cpp

マクロ定義

関数

5.3.1 説明

5.3.2 マクロ定義

5.3.3 関数

5.4 urg.h

構成

関数

5.4.1 説明

5.4.2 関数

5.5 urgComp.cpp

関数

5.5.1 説明

5.5.2 関数

Index

URG ^{センサコンポーネント}

2.1 ^構成

3.1 ^{ファイル一覧}

4.1 ^クラス CSerial

Public ^メソッド

4.1.1 ^説明

4.1.3 ^関数

4.2 ^クラス urg

Public ^メソッド

Protected ^変数

4.2.1 ^説明

4.2.3 ^関数

4.2.4 ^変数

5.1.1 ^説明

5.2.1 ^説明

5.3.1 ^説明

5.3.2 ^{マクロ定義}

5.3.3 ^関数

5.4.1 ^説明

5.4.2 ^関数

5.5.1 ^説明

5.5.2 ^関数