Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / ja_JP / scilab_data_structures / scicos_params.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="scicos_params">
25     <refnamediv>
26         <refname>scicos_params</refname>
27         <refpurpose>param構造体の定義</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_params">
30         <title>モジュール</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsection id="params_scicos_params">
40         <title>params</title>
41         <para>
42             大きさ : 11.
43         </para>
44         <para>
45             型 : scilab リスト.
46         </para>
47         <para>
48         </para>
49         <itemizedlist>
50             <listitem>
51                 <para>
52                     <emphasis role="bold">wpar</emphasis>
53                 </para>
54                 <para> このベクトルは現在使用されていません.</para>
55                 <para> 将来,エディタのウィンドウの大きさを指定するために
56                     使用される可能性があります.
57                 </para>
58                 <para> 
59                     大きさ : 6.
60                 </para>
61                 <para>
62                     型 : 列ベクトルまたは実数.
63                 </para>
64             </listitem>
65             <listitem>
66                 <para>
67                     <emphasis role="bold">title</emphasis>
68                 </para>
69                 <para> 文字列のベクトルで,
70                     最初の文字列はダイアグラムのタイトルで,
71                     保存するファイル名のデフォルト名です.
72                     2番目の文字列は,ファイル名のディレクトリのパスです.
73                 </para>
74                 <para> 
75                     大きさ : 2.
76                 </para>
77                 <para>
78                     型 : 文字列の行ベクトル.
79                 </para>
80             </listitem>
81             <listitem>
82                 <para>
83                     <emphasis role="bold">tol</emphasis>
84                 </para>
85                 <para> 
86                     ソルバーにより使用されつ種々の許容誤差を含むシミュレーションパラメータを保持するベクトル.
87                 </para>
88                 <itemizedlist>
89                     <listitem>
90                         <para>
91                             <emphasis role="bold">atol  </emphasis>
92                         </para>
93                         <para>
94                             数値ソルバーの積分器の絶対許容誤差.
95                         </para>
96                         <para>
97                         </para>
98                     </listitem>
99                     <listitem>
100                         <para>
101                             <emphasis role="bold">rtol  </emphasis>
102                         </para>
103                         <para>
104                             数値ソルバーの積分器の相対許容誤差.
105                         </para>
106                         <para>
107                         </para>
108                     </listitem>
109                     <listitem>
110                         <para>
111                             <emphasis role="bold">ttol  </emphasis>
112                         </para>
113                         <para>
114                             時間に関する許容誤差.
115                         </para>
116                         <para>
117                             積分間隔がttolより小さい場合,数値ソルバーはコールされません.
118                         </para>
119                         <para>
120                         </para>
121                     </listitem>
122                     <listitem>
123                         <para>
124                             <emphasis role="bold">deltat</emphasis>
125                         </para>
126                         <para>
127                             積分時間間隔の最大値.
128                         </para>
129                         <para>
130                             積分周期がdeltatより大きい場合,
131                             各コールの積分周期がdeltat以下となるように
132                             数値ソルバーが複数回コールされます.
133                         </para>
134                     </listitem>
135                     <listitem>
136                         <para>
137                             <emphasis role="bold">scale </emphasis>
138                         </para>
139                         <para>
140                             実時間スケーリング; 値0は実時間スケーリングをしないことを意味します.
141                         </para>
142                         <para>
143                             Scicosシミュレーション時間を実時間(単位:秒)に関連付けます.
144                         </para>
145                         <para>
146                             値1はScicosの各時間単位を1秒に対応付けることを意味します.
147                         </para>
148                         <para>
149                         </para>
150                     </listitem>
151                     <listitem>
152                         <para>
153                             <emphasis role="bold">solver</emphasis>
154                         </para>
155                         <para>
156                             数値ソルバーを選択.
157                         </para>
158                         <para>
159                             値0はODEソルバー, 100はDAEソルバーを意味します.
160                         </para>
161                         <para>
162                         </para>
163                     </listitem>
164                     <listitem>
165                         <para>
166                             <emphasis role="bold">hmax  </emphasis>
167                         </para>
168                         <para>
169                             数値ソルバーの最大ステップ数.
170                         </para>
171                         <para>
172                             0 は制限なしを意味します.
173                         </para>
174                         <para>
175                         </para>
176                         <para>           
177                         </para>
178                     </listitem>
179                 </itemizedlist>
180                 <para> 
181                     大きさ : 7.
182                 </para>
183                 <para>
184                     型 : 実数の列ベクトル.
185                 </para>
186             </listitem>
187             <listitem>
188                 <para>
189                     <emphasis role="bold">tf</emphasis>
190                 </para>
191                 <para> シミュレーション終了時間.</para>
192                 <para> シミュレーションはこの時刻で停止します.</para>
193                 <para> デフォルト値は 100000です.</para>
194                 <para> 
195                     大きさ : 1.
196                 </para>
197                 <para>
198                     型 : 実数.
199                 </para>
200             </listitem>
201             <listitem>
202                 <para>
203                     <emphasis role="bold">context</emphasis>
204                 </para>
205                 <para>
206                     記号パラメータとしてダイアグラムのブロック内で使用される
207                     Scilab変数を定義するScilab命令を含む文字列のベクトル.
208                 </para>
209                 <para> 
210                     コメントを含む有効な全てのScilab命令を使用できます.
211                 </para>
212                 <para> 
213                     大きさ : コンテキストの行数.
214                 </para>
215                 <para>
216                     型 : 文字列の列ベクトル.
217                 </para>
218             </listitem>
219             <listitem>
220                 <para>
221                     <emphasis role="bold">void1</emphasis>
222                 </para>
223                 <para> 使用されないフィールド.</para>
224                 <para> 
225                     大きさ : -.
226                 </para>
227                 <para>
228                     型 : -.
229                 </para>
230             </listitem>
231             <listitem>
232                 <para>
233                     <emphasis role="bold">options</emphasis>
234                 </para>
235                 <para>
236                     背景色やリンク色のようなエディタのグラフィックプロパティを定義する
237                     scsopt型のScilabオブジェクト.
238                 </para>
239                 <para> 
240                     フィールドは以下のようになります:
241                 </para>
242                 <itemizedlist>
243                     <listitem>
244                         <para>
245                             <emphasis role="bold">3D        </emphasis>
246                         </para>
247                         <para>
248                             2つのエントリを有するリスト. 最初のエントリは論理値で,
249                             ブロックが3次元的な外観を有するかどうかを指定します.
250                         </para>
251                         <para>
252                             第2エントリはカレントの色マップにおける色を指定し,
253                             3次元効果を生成する際に使用されます.
254                         </para>
255                         <para>
256                             デフォルトは33で, 
257                             Scicosにより32色を有する標準カラーマップに追加される灰色に対応します.
258                         </para>
259                         <para>
260                             デフォルト値は list(%t,33) です.
261                         </para>
262                         <para>
263                         </para>
264                     </listitem>
265                     <listitem>
266                         <para>
267                             <emphasis role="bold">Background</emphasis>
268                         </para>
269                         <para>
270                             2つのエントリを有するベクトル: 背景色および
271                             表示色.
272                         </para>
273                         <para>
274                             デフォルト値は [8,1] です.
275                         </para>
276                         <para>
277                         </para>
278                     </listitem>
279                     <listitem>
280                         <para>
281                             <emphasis role="bold">link      </emphasis>
282                         </para>
283                         <para>
284                             標準およびアクティベーションリンクの
285                             デフォルトのリンク色.
286                         </para>
287                         <para>
288                             これらの色はリンク接続でのみ使用されます.
289                         </para>
290                         <para>
291                             これらを変更しても既に接続済みのリンクには影響を与えません.
292                         </para>
293                         <para>
294                             デフォルト値は [1,5] で, これらは標準Scilabカラーマップが
295                             使用されている場合は黒と赤に対応します.
296                         </para>
297                         <para>
298                         </para>
299                     </listitem>
300                     <listitem>
301                         <para>
302                             <emphasis role="bold">ID        </emphasis>
303                         </para>
304                         <para>
305                             フォント番号と大きさを有する2つのベクトルのリスト.
306                         </para>
307                         <para>
308                             デフォルト値は [5,1],[4,1]です.
309                         </para>
310                         <para>
311                         </para>
312                     </listitem>
313                     <listitem>
314                         <para>
315                             <emphasis role="bold">Cmap      </emphasis>
316                         </para>
317                         <para>
318                             カラーマップに追加される色のRGB値を有する
319                             n行3列の行列です.
320                         </para>
321                         <para>
322                             デフォルト値は [0.8,0.8,0.8], すなわち灰色です.
323                         </para>
324                         <para>
325                         </para>
326                         <para>           
327                         </para>
328                     </listitem>
329                 </itemizedlist>
330                 <para> 
331                     大きさ : 6.
332                 </para>
333                 <para>
334                     型 : scsopt型のscilab tlist.
335                 </para>
336             </listitem>
337             <listitem>
338                 <para>
339                     <emphasis role="bold">void2</emphasis>
340                 </para>
341                 <para> 使用されていないフィールド.</para>
342                 <para> 
343                     大きさ : -.
344                 </para>
345                 <para>
346                     型 : -.
347                 </para>
348             </listitem>
349             <listitem>
350                 <para>
351                     <emphasis role="bold">void3</emphasis>
352                 </para>
353                 <para> 使用されていないフィールド.</para>
354                 <para> 
355                     大きさ : -.
356                 </para>
357                 <para>
358                     型 : -.
359                 </para>
360             </listitem>
361             <listitem>
362                 <para>
363                     <emphasis role="bold">doc</emphasis>
364                 </para>
365                 <para> ユーザ定義のダイアグラム文書構造体.</para>
366                 <para> 
367                     大きさ : 1.
368                 </para>
369                 <para>
370                     型 : 文字列.
371                 </para>
372             </listitem>
373         </itemizedlist>
374     </refsection>
375     <refsection id="Filecontent_scicos_params">
376         <title>ファイルの内容</title>
377         <itemizedlist>
378             <listitem>
379                 <para> SCI/modules/scicos/macros/scicos_scicos/scicos_params.sci</para>
380             </listitem>
381         </itemizedlist>
382     </refsection>
383 </refentry>