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

(1)

リファレンスマニュアル

作成： Doxygen 1.5.5

Fri Mar 6 23:05:53 2009

(2)

(3)

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

用表示コンポーネント

URG^{センサコンポーネント}urgComp用の表示コンポーネントですつくばチャレンジ用に作成したプログラムです。

センサのチェックのために作成したコンポーネントです．

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

注意_:

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

日付_:

2008.03.03 作者_:

Chiba Institute of Technology

(6)

(7)

Chapter 2 構成索引

2.1 ^構成

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

urgPanel(Urgのデータを表示するパネルクラス) . . . 7

urgView (UrgView^のクラス) . . . 10

urgViewComp (UrgViewのコンポーネントクラス ) . . . 12

urgViewImpl(UrgViewを実装するためのクラス) . . . 13

(8)

(9)

Chapter 3 ファイル索引

3.1 ^{ファイル一覧}

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

urgPanel.java(Urgのデータを表示するパネルクラス) . . . 17

urgView.java(UrgView^のクラス) . . . 18

urgViewComp.java(UrgViewのコンポーネントクラス) . . . 19

urgViewImpl.java(UrgViewを実装するためのクラス) . . . 20

(10)

(11)

Chapter 4 クラス

4.1 ^クラス urgPanel

urgのデータを表示するパネルクラス

Public ^メソッド

void paint(Graphics g) 再描画時に呼び出される関数

void setPara(long num, oat sAng, oat eAng) 角度とデータ個数のパラメータを設定する関数

void setData(short[ ] in_data) urgの計測データを設定する

関数

urgPanel() コンストラクタ

変数

long numData データの個数

oatstartAngle 計測を開始する角度

oatendAngle

(12)

8 ^クラス

計測を終了する角度

short[ ]data

URG^{の計測データ}

4.1.1 ^説明

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

4.1.2.1 urgPanel::urgPanel () [inline, package]

コンストラクタ

4.1.3 ^関数

4.1.3.1 void urgPanel::paint (Graphics g) [inline] 再描画時に呼び出される関数

urgのデータを線で描画する

4.1.3.2 void urgPanel::setPara (long num, oat sAng, oat eAng) [inline]

角度とデータ個数のパラメータを設定する関数

引数_:

← num データの個数

← sAng 計測を開始する角度

← eAng 計測を終了する角度

戻り値_: 無し

4.1.3.3 void urgPanel::setData (short[ ] in_data) [inline] urgの計測データを設定する

Fri Mar 6 23:05:53 2009^{に生成されました。}Doxygen

(13)

4.1 ^クラス urgPanel 9

引数_:

← in_data URG の計測データ

戻り値_: 無し

4.1.4 ^変数

4.1.4.1 long urgPanel::numData [package] データの個数

4.1.4.2 oat urgPanel::startAngle [package] 計測を開始する角度

4.1.4.3 oat urgPanel::endAngle [package] 計測を終了する角度

4.1.4.4 short [ ] urgPanel::data [package] URG^{の計測データ}

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

urgPanel.java

(14)

10 ^クラス

4.2 ^クラス urgView

urgView^のクラス

RtcNewFunc,^とRtcDeleteFunc^{を継承しています。}

Public ^メソッド

RTObject_implcreateRtc(Manager mgr)

void deleteRtc(RTObject_impl rtcBase)

Static Public ^変数

static Stringcomponent_conf[ ]

4.2.1 ^説明

4.2.2 ^関数

4.2.2.1 RTObject_impl urgView::createRtc (Manager mgr) [inline]

4.2.2.2 void urgView::deleteRtc (RTObject_impl rtcBase) [inline]

4.2.3 ^変数

4.2.3.1 String urgView::component_conf[ ] [static]

初期値_:

{ "implementation_id", "urgView",

"type_name", "urgView",

"description", "viewer for urg",

"version", "1.0.0",

"vendor", "CIT",

"category", "Category",

"activity_type", "DataFlowComponent",

"max_instance", "10",

"language", "Java",

(15)

4.2 ^クラス urgView 11

"lang_type", "compile",

"conf.default.type", "1",

"" }

urgView.java

(16)

12 ^クラス

4.3 ^クラス urgViewComp

urgViewのコンポーネントクラス ModuleInitProc^{を継承しています。}

Public ^メソッド

void myModuleInit(Manager mgr)

Static Public ^メソッド

static voidmain (String[ ] args)

4.3.1 ^説明

urgViewのコンポーネントクラス

4.3.2 ^関数

4.3.2.1 void urgViewComp::myModuleInit (Manager mgr) [inline]

4.3.2.2 static void urgViewComp::main (String[ ] args) [inline, static]

urgViewComp.java

(17)

4.4 ^クラス urgViewImpl 13

4.4 ^クラス urgViewImpl

urgViewを実装するためのクラス

DataFlowComponentBase^{を継承しています。}

Public ^メソッド

urgViewImpl(Manager manager) コンストラクタ

Protected ^メソッド

ReturnCode_tonInitialize() 初期化処理

ReturnCode_tonFinalize() 終了処理

ReturnCode_tonExecute(int ec_id) アクティベート中に定期的に呼び出される関数

Protected ^変数

ShortHolder m_type= new ShortHolder() URGセンサのタイプ（現在は使用していない）

TimedShortSeqm_urgData_val URGのデータを出力するための配列

DataRef< TimedShortSeq > m_urgData

InPort< TimedShortSeq >m_urgDataIn

変数

urgPanel uPanel 表示用パネル

FileWriterfw ファイル書き込み

(18)

14 ^クラス

4.4.1 ^説明

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

4.4.2.1 urgViewImpl::urgViewImpl (Manager manager) [inline]

コンストラクタ

4.4.3 ^関数

4.4.3.1 ReturnCode_t urgViewImpl::onInitialize () [inline, protected]

初期化処理

パラメータの初期化と_GUIの設定戻り値_:

RTC_OK

4.4.3.2 ReturnCode_t urgViewImpl::onFinalize () [inline, protected]

終了処理

戻り値_:

親クラスのonFinalize()

4.4.3.3 ReturnCode_t urgViewImpl::onExecute (int ec_id) [inline, protected]

アクティベート中に定期的に呼び出される関数

新しいデータを受信すれば，データの長さを調べて適切(768!=TopURG)であれば表示用のパネルクラスにデータをセットする

同時に_urg.txtというファイルに保存する

戻り値_:

親クラスのonExecute()

(19)

4.4 ^クラス urgViewImpl 15

4.4.4 ^変数

4.4.4.1 ShortHolder urgViewImpl::m_type = new ShortHolder() [protected]

URGセンサのタイプ（現在は使用していない）

4.4.4.2 TimedShortSeq urgViewImpl::m_urgData_val [protected] URGのデータを出力するための配列

4.4.4.3 DataRef<TimedShortSeq> urgViewImpl::m_urgData [protected]

4.4.4.4 InPort<TimedShortSeq> urgViewImpl::m_urgDataIn [protected]

4.4.4.5 urgPanel urgViewImpl::uPanel [package] 表示用パネル

4.4.4.6 FileWriter urgViewImpl::fw [package]

ファイル書き込み

urgViewImpl.java

(20)

(21)

Chapter 5 ファイル

5.1 urgPanel.java

構成

classurgPanel

5.1.1 ^説明

日付_:

2008.03.03 作者_:

Y.Hayashibara

(22)

18 ^ファイル

5.2 urgView.java

構成

classurgView urgView^のクラス

5.2.1 ^説明

日付_:

2008.03.03

作者_:

Y.Hayashibara

(23)

5.3 urgViewComp.java 19

5.3 urgViewComp.java

構成

classurgViewComp

5.3.1 ^説明

URGのデータ取得コンポーネント_urgComp用表示コンポーネント

日付_:

2008.03.03

作者_:

Y.Hayashibara

(24)

20 ^ファイル

5.4 urgViewImpl.java

構成

classurgViewImpl

5.4.1 ^説明

日付_:

2008.03.03

作者_:

Y.Hayashibara

(25)

Index

component_conf urgView,10 createRtc

urgView,10 dataurgPanel,9 deleteRtc

urgView,10 endAngle

urgPanel,9 fw urgViewImpl,15

m_type

urgViewImpl,15 m_urgData

urgViewImpl,15 m_urgData_val

urgViewImpl,15 m_urgDataIn

urgViewImpl,15 mainurgViewComp,12 myModuleInit

urgViewComp,12 numData

urgPanel,9 onExecute

urgViewImpl,14 onFinalize

urgViewImpl,14 onInitialize

urgViewImpl,14 paint

urgPanel,8 setData

urgPanel,8 setPara

urgPanel,8

startAngle urgPanel,9 uPanel

urgViewImpl,15 urgPanel,7

data,9 endAngle,9 numData,9 paint,8 setData,8 setPara,8 startAngle,9 urgPanel,8 urgPanel.java,17 urgView,10

component_conf,10 createRtc,10 deleteRtc,10 urgView.java,18 urgViewComp,12

main,12

myModuleInit,12 urgViewComp.java,19 urgViewImpl,13

fw,15 m_type,15 m_urgData,15 m_urgData_val,15 m_urgDataIn,15 onExecute,14 onFinalize,14 onInitialize,14 uPanel,15 urgViewImpl,14 urgViewImpl.java,20

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

リファレンスマニュアル

作成： Doxygen 1.5.5

Contents

Chapter 1

URG センサコンポーネント urgComp

用表示コンポーネント

Chapter 2

構成索引

2.1 構成

Chapter 3

ファイル索引

3.1 ファイル一覧

Chapter 4

クラス

4.1 クラス urgPanel

Public メソッド

関数

変数

4.1.1 説明

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

4.1.3 関数

4.1.4 変数

4.2 クラス urgView

Public メソッド

Static Public 変数

4.2.1 説明

4.2.2 関数

4.2.3 変数

4.3 クラス urgViewComp

Public メソッド

Static Public メソッド

4.3.1 説明

4.3.2 関数

4.4 クラス urgViewImpl

Public メソッド

Protected メソッド

Protected 変数

変数

4.4.1 説明

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

4.4.3 関数

4.4.4 変数

Chapter 5

ファイル

5.1 urgPanel.java

構成

5.1.1 説明

5.2 urgView.java

構成

5.2.1 説明

5.3 urgViewComp.java

構成

5.3.1 説明

5.4 urgViewImpl.java

構成

5.4.1 説明

Index

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

2.1 ^構成

3.1 ^{ファイル一覧}

4.1 ^クラス urgPanel

Public ^メソッド

4.1.1 ^説明

4.1.3 ^関数

4.1.4 ^変数

4.2 ^クラス urgView

Public ^メソッド

Static Public ^変数

4.2.1 ^説明

4.2.2 ^関数

4.2.3 ^変数

4.3 ^クラス urgViewComp

Public ^メソッド

Static Public ^メソッド

4.3.1 ^説明

4.3.2 ^関数

4.4 ^クラス urgViewImpl

Public ^メソッド

Protected ^メソッド

Protected ^変数

4.4.1 ^説明

4.4.3 ^関数

4.4.4 ^変数

5.1.1 ^説明

5.2.1 ^説明

5.3.1 ^説明

5.4.1 ^説明