月別: 2016年4月

さてと、前回はTRNSYSの関数をC/C++コンポーネントから使う際の基本的な流れを解説しました。 今回は、もう少し具体的に掘り下げてみたいと思います。TRNSYSの関数と一口に言っていますが、ソースコードを眺めるとFunctionとして定義されている物と、Subroutineとして定義されている物の2種類あるのが分かります。 この2つ、ざっくり戻り値があるかないかの違いです。（C/C++から呼び出す際はどちらも関数として扱います）表にするとFunctionとSubroutineって戻り値があるか、ないか(void）の違いなんですよね。

	戻り値の型	引数の型
Function	Integer, Double Precision	なし、 Integer, Double Precision
Subroutine	なし	なし、 Integer, Double Precision

TRNSYSでは戻り値を返すgetIsVersionSigningTime()のように”get”で始まる関数はFunctionで、それ以外の関数はSubroutineとして定義されている事が多いようです。

C/C++の宣言

C/C++から呼び出す際の定義は以下の形式になります。ソースコードを調べて赤い文字の部分を適宜、型に合わせて変更します。

extern “C” __declspec(dllimport) 戻り値の型 _cdecl 関数名(引数の型* 引数の名前, 引数の型* 引数の名前);

例）SetTypeVersion() extern “C” __declspec(dllimport) void _cdecl SETTYPEVERSION(int* ver);

FOTRANとC/C++の値の型の対応は下表のようになります。

FORTRAN	C/C++
Integer,Integer(4)	int
Real(8),Double Precesion	double
Real(4)	float

なお、引数はすべてポインタで宣言する点に注意して下さい。※

※2016/4/25 追記 FORTRAN側で引数にVALUE属性（値渡し）が指定されている場合を除く。（その場合は、通常の型で定義する必要があります）

別名の定義

関数に別名（Alias）を付けて場合は以下の形式です。この部分はなくても問題ありませんが、TRNDLL.DLLで公開されている関数名そのままだと、ソースコードが読みにくくなります。ここは多少手間でも定義しておくのがお勧めです。

#define     別名          関数名

例）SetTypeVersion()

#define setTypeVersion                    SETTYPEVERSION

ヘッダーファイルの準備

Simulation Studioからエクスポートされたプロジェクトでは予めTRNSYS16形式で最小限の関数が定義されてたヘッダーファイルを参照しています。

TRNSYS17形式のヘッダーファイル（こちらも最小限の関数が定義されています）も用意されているので、こちらへ差し替えて定義を追加するのが良いでしょう。

TRNSYS17形式のヘッダーファイルはC:Trnsys17SourceCodeTemplatesTRNSYS.h　に用意されているので、このファイルをプロジェクトのフォルダへコピー、追加して登録します。

ヘッダーファイルを追加

ヘッダーファイル（TRNSYS.h)をプロジェクトのフォルダへコピーしたら、ソリューションエクスプローラーの「Header Files」フォルダで右クリック。表示されるメニューから[追加]-[既存の項目]を選んで、ヘッダーファイルを追加します。

後は適宜関数の定義を追加すればOK.

参考までに作成したサンプルをGithubで公開します。

プロフォルマ

C:¥TRNSYS17¥Studio¥Proformas¥My Components  へダウンロード、保存してください。

ソースコード

「Step7」フォルダの内容をC:¥TRNSYS17¥Compilers¥My Components へダウンロード、保存してください。

実行用のサンプルプロジェクト

C:¥TRNSYS17¥MyProjects¥MyComponent201 へダウンロード、保存してください。
ということで、C/C＋＋は今回で終了！

—————————————————-

以下、このシリーズの目次

作ってみようTRNSYSコンポーネント　C/C++編
(1)　基本情報
(2)　ソースコードの生成
(3)　ソースコードを読んでみよう
(4)　Simulation Studioで実行してみよう
(5)　コンポーネントが呼び出されるタイミング
(6)　ヘッダーファイル・基本編
(7)　ヘッダーファイル・実践編

だいぶ間が空いてしまいましたが、「作ってみようTRNSYS.JPコンポーネント C/C++編」シリーズの続きです。

TRNSYS16 vs TRNSYS17

TRNSYS16までのコンポーネント開発では、INFO()配列のデータを使って処理の制御やデータの設定を行っていました。TRNSYS17以降では専用の関数が用意されたため、ソースコードの可読性が非常に高くなりました。ただし、残念ながらこれはFORTRANのみのサポートになります。

とはいえ関数自体はC/C++からも呼び出すことが可能です。ヘッダーファイルへ適切な宣言を行うことで利用可能です。（これTRNSYSに限らず、FOTRANのサブルーチンや関数をC/C++から利用するお話です。FOTRANの資産をC/C++でご利用になりたい向きも当てはまる話です） という訳で、ヘッダーファイルの作り方など解説してみたいと思います。

1.TRNSYSの関数名を取得する

公開されているTRNSYSの関数名を取得します。TRNSYSの関数はTRNDLL.DLL（C:TRNSYS17ExeTRNDLL.DLL）にすべて含まれていますが、FORTRANで利用する際とは異なる名前で公開されている関数が複数存在します。

C/C++から呼び出すため、関数名をTRNDLL.DLLより直接取得します。関数名の取り出しはVisual Studioに含まれる開発ツールを使用して行います。 はじめに、開発ツールを使用するための準備を行います。キーボーから[Win]+[R]をクリックして表示されるダイアログで”cmd”と入力してコマンドプロンプトを起動します。

コマンドプロンプトから以下のバッチファイルを実行して、開発ツールの利用環境を整えます。以下、Visual Studio 2013がインストールされたPCの作業例です。

> “C:Program Files (x86)Microsoft Visual Studio 12.0Common7Toolsvsvars32.bat”

つづいて、dumpbin.exeを使って、TRNDLL.DLLから関数名のリストを取得します。

> cd C:\TRNSYS17\Exe

> dumpbin /exports TRNDLL.DLL > trnsysfunctions.txt

これでtrnsysfunctions.txtに関数名がすべて書き出されました。

2.関数定義の確認

関数の引数や戻り値を調べるためFORTRANの関数定義を確認します。

TRNSYSのすべて関数のソースコードは「C:TRNSYS17SourceCodeKernel」フォルダに格納されています。これらのソースコードから、関数を定義しているソースコードを特定、定義内容を確認します。

ここでは、C/C++のソースコードの以下の箇所（コンポーネントのバージョン宣言処理の判定）に対応する関数getIsVersionSigningTime()を例に定義箇所を探してみます。（info配列と関数の対応はドキュメント「7.2. Updating TRNSYS 16 Components to the TRNSYS 17 Coding Standard」を参考にして調べます。）

//    SET THE VERSION INFORMATION FOR TRNSYS
if (info[6]== -2) ←この部分をTRNSYS17形式の関数にします。
{
info[11]=16;
// add additional initialisation code here, if any
return 1;
}

コマンドプロンプトから次のように入力して定義箇所を検索します。

> cd c:Trnsys17SourceCodeKernel

> findstr /i “getIsVersionSigningTime” .*.f90 | findstr /i “DLLEXPORT” .TrnsysFunctions.f90: !dec$ attributes dllexport :: getIsVersionSigningTime >

実行すると、関数を含むファイルの名前と定義されている行が表示されます。この例では「TrnsysFunctions.f90」に関数が含まれていることが分かります。 ソースコード調べると引数なし、戻り値はIntegerで定義されていることが分かります。

さらに、１．で作成したリストから公開されている関数名を確認します。メモ帳などでtrnsysfucntions.txtを開いて、”getIsVersionSigningTime” を検索してみると。。。

“TRNSYSFUNCTIONS_mp_GETISVERSIONSIGNINGTIME”という名前で公開されている事が分かります。（なんでこんな長い名前で公開されているかは謎ですが。。。）

3.ヘッダーファイルへ定義する

必要な情報が整ったので、いよいよ関数の定義を追加します。ここで目的の関数「getIsVersionSigningTime」の情報を整理すると。。。

• 引数：なし
• 戻り値：Integer
• 名前：”TRNSYSFUNCTIONS_mp_GETISVERSIONSIGNINGTIME”

ここまで分かればC/C++の関数として定義できます。 具体的には、戻り値は整数(int)、引数はなし(void)として次のような定義になります。

extern “C” __declspec(dllimport) int _cdecl TRNSYSFUNCTIONS_mp_GETISVERSIONSIGNINGTIME(void);

しかし、これだと関数名が長くて、しかも大文字だらけで読みにくいので別名を定義します。

#define getIsVersionSigningTime            TRNSYSFUNCTIONS_mp_GETISVERSIONSIGNINGTIME

これでC/C++のソースコードから”getIsVersionSigningTime()”として呼び出すことができるようになります。次のようなイメージでソースコードを書き換える事ができるようになります。

//    SET THE VERSION INFORMATION FOR TRNSYS
if (getIsVersionSigningTime())
{
info[11]=16;
// add additional initialisation code here, if any
return 1;
}

でも、これたぶんエラーになります。TRNSYS17形式に書き換える場合、他の関数も同じように書き換える必要があります。この例ではinfo[11]へ値を設定していますが、これも関数に置き換える必要があります。 今回はヘッダーファイルを準備する基本的な流れと言うことで、たぶん

次回へつづく。

—————————————————-

以下、このシリーズの目次

作ってみようTRNSYSコンポーネント　C/C++編
(1)　基本情報
(2)　ソースコードの生成
(3)　ソースコードを読んでみよう
(4)　Simulation Studioで実行してみよう
(5)　コンポーネントが呼び出されるタイミング
(6)　ヘッダーファイル・基本編
(7)　ヘッダーファイル・実践編