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

(1)

リファレンスマニュアル

作成： Doxygen 1.5.5

Fri Mar 6 23:03:40 2009

(2)

(3)

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

GPS^センサ(Hemisphere A100)により位置を取得するコンポーネントです。つくばチャレンジ用に作成したプログラムです。

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

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

日付_:

2008.03.03

作者_:

Chiba Institute of Technology

(6)

(7)

Chapter 2 構成索引

2.1 ^構成

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

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

(8)

(9)

Chapter 3 ファイル索引

3.1 ^{ファイル一覧}

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

gps.cpp(GPSセンサからデータを取得するためのコンポーネント) . . . 15

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

gpsComp.cpp(GPSのデータを取得するコンポーネント) . . . 17

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

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

(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(char ∗data, int len) テキストデータを送信する

(12)

8 ^クラス

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

intClearRecvBuf()

speed_tbitrate(int aBR)

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

Public ^変数

FILE ∗device デバイス名

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 23:03:40 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 (char ∗ data, 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 ()

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

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

← aBR ボーレート戻り値_:

ボーレートの定数

4.1.4 ^変数

4.1.4.1 FILE∗ CSerial::device

デバイス名

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

serial.h

serial.cpp

(15)

4.2 ^クラス gps 11

4.2 ^クラス gps

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

#include <gps.h>

Public ^メソッド

gps(RTC::Manager ∗manager)

∼gps ()

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

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 シリアル通信のデバイス名

TimedFloatSeqm_gpsData

緯度、経度、高度，衛星数を含む位置データ配列（コンポーネント出力）

OutPort< TimedFloatSeq >m_gpsDataOut

4.2.1 ^説明

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

(16)

12 ^クラス

4.2.2.1 gps::gps (RTC::Manager ∗ manager)

4.2.2.2 gps::∼gps ()

4.2.3 ^関数

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

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

RTC_OK

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

コンポーネントを終了するときに呼び出される関数現在は何もしない

戻り値_: RTC_OK

4.2.3.3 RTC::ReturnCode_t gps::onActivated (RTC::UniqueId ec_id) [virtual]

コンポーネントをアクティベートするときに呼ばれる関数

シリアル通信デバイスがオープンしていないときデバイスをオープンするまた、_GPSセンサに初期化のデータを送信する

戻り値_:

RTC_OK:^成功、RTC_ERROR:^失敗

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

コンポーネントをデアクティベートするときに呼ばれる関数シリアル通信デバイスがオープンしているときクローズする

(17)

4.2 ^クラス gps 13

戻り値_: RTC_OK

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

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

データを緯度，経度，高度，衛星数_(oat型₎に変更した後、コンポーネントの出力に送る_param[out] m_gpsData緯度，経度，高度，衛星数データの配列

戻り値_: RTC_OK

4.2.4 ^変数

4.2.4.1 std::string gps::m_devName [protected]

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

4.2.4.2 TimedFloatSeq gps::m_gpsData [protected]

緯度、経度、高度，衛星数を含む位置データ配列（コンポーネント出力）

4.2.4.3 OutPort<TimedFloatSeq> gps::m_gpsDataOut [protected]

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

gps.h

gps.cpp

(18)

(19)

Chapter 5 ファイル

5.1 gps.cpp

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

#include "gps.h"

関数

void gpsInit(RTC::Manager ∗manager)

5.1.1 ^説明

日付_:

2008.03.03

作者_:

T.Hayashi H.Kumada

5.1.2 ^関数

5.1.2.1 void gpsInit (RTC::Manager ∗ manager)

(20)

16 ^ファイル

5.2 gps.h

#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"

構成

classgps

関数

void gpsInit(RTC::Manager ∗manager)

5.2.1 ^説明

日付_:

2008.03.03

作者_:

T.Hayashi H.Kumada

5.2.2 ^関数

5.2.2.1 void gpsInit (RTC::Manager ∗ manager)

(21)

5.3 gpsComp.cpp 17

5.3 gpsComp.cpp

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

#include <rtm/Manager.h>

#include <iostream>

#include <string>

#include <stdlib.h>

#include "gps.h"

関数

void MyModuleInit(RTC::Manager ∗manager)

intmain (int argc, char ∗∗argv)

5.3.1 ^説明

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

日付_:

2008.03.03

作者_:

T.Hayashi Y.Hayashibara

5.3.2 ^関数

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

5.3.2.2 void MyModuleInit (RTC::Manager ∗ manager)

(22)

18 ^ファイル

5.4 serial.cpp

#include "serial.h"

5.4.1 ^説明

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

2008.03.03

(23)

5.5 serial.h 19

5.5 serial.h

#include <stdio.h>

#include <string.h>

#include <stdlib.h>

#include <sys/termios.h>

構成

classCSerial

5.5.1 ^説明

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

2008.03.03

(24)

Index

∼CSerial CSerial,8

∼gpsgps,12 bitrate

CSerial,10 ClearRecvBuf

CSerial,10 Close

CSerial,9 CSerial,7

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

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

Recv,10 Send,9 device

CSerial,10 getBaudRate

CSerial,8 getDevice

CSerial,8 getPortName

CSerial,9 gps,11

∼gps,12 gps,11

m_devName,13 m_gpsData,13 m_gpsDataOut,13 onActivated,12 onDeactivated,12 onExecute,13 onFinalize,12 onInitialize,12

gps.cpp,15 gpsInit,15 gps.h,16

gpsInit,16 gpsComp.cpp,17

main,17

MyModuleInit,17 gpsInit

gps.cpp,15 gps.h,16 m_devName

gps,13 m_gpsData

gps,13 m_gpsDataOut

gps,13

maingpsComp.cpp,17 MyModuleInit

gpsComp.cpp,17 onActivated

gps,12 onDeactivated

gps,12 onExecute

gps,13 onFinalize

gps,12 onInitialize gps,12 OpenCSerial,9

RecvCSerial,10

SendCSerial,9 serial.cpp,18 serial.h,19

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

リファレンスマニュアル

作成： Doxygen 1.5.5

Contents

Chapter 1

GPS センサコンポーネント

Chapter 2

構成索引

2.1 構成

Chapter 3

ファイル索引

3.1 ファイル一覧

Chapter 4

クラス

4.1 クラス CSerial

Public メソッド

Public 変数

4.1.1 説明

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

4.1.3 関数

4.1.4 変数

4.2 クラス gps

Public メソッド

Protected 変数

4.2.1 説明

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

4.2.3 関数

4.2.4 変数

Chapter 5

ファイル

5.1 gps.cpp

関数

5.1.1 説明

5.1.2 関数

5.2 gps.h

構成

関数

5.2.1 説明

5.2.2 関数

5.3 gpsComp.cpp

関数

5.3.1 説明

5.3.2 関数

5.4 serial.cpp

5.4.1 説明

5.5 serial.h

構成

5.5.1 説明

Index

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

2.1 ^構成

3.1 ^{ファイル一覧}

4.1 ^クラス CSerial

Public ^メソッド

Public ^変数

4.1.1 ^説明

4.1.3 ^関数

4.1.4 ^変数

4.2 ^クラス gps

Public ^メソッド

Protected ^変数

4.2.1 ^説明

4.2.3 ^関数

4.2.4 ^変数

5.1.1 ^説明

5.1.2 ^関数

5.2.1 ^説明

5.2.2 ^関数

5.3.1 ^説明

5.3.2 ^関数

5.4.1 ^説明

5.5.1 ^説明