Control key types: Difference between revisions

From FFDevel Wiki
Jump to navigation Jump to search
(Created page with "Navigation: Documentation / Control files / Control key types ---- The control files contains keys and their values. Values might be one of following type: {| sty...")
 
No edit summary
Line 18: Line 18:
| logical
| logical
| This is a boolean value, which can have two values: true or false.<br/>The true value can be entered as: on, ON, true, TRUE, T, 1<br/>The false value can be entered as: off, OFF, false, FALSE, F, 0<br/>Other entries are ignored and the keyword line is not marked as processed.
| This is a boolean value, which can have two values: true or false.<br/>The true value can be entered as: on, ON, true, TRUE, T, 1<br/>The false value can be entered as: off, OFF, false, FALSE, F, 0<br/>Other entries are ignored and the keyword line is not marked as processed.
|- style="vertical-align: top; background-color: #f6f6f6;"
| mask
| This is a string entry that is further processed as an ASL mask. The mask syntax is described [[Mask format|here]] in details. Please note that a mask can contain star (*) or exclamation mark (!) characters, which are normaly used as leading characters of comments. In such a case, the string must be encompased by quotation marks.
|}
|}




'''Examples'''
'''Examples'''
  fserver     "abf://skirit.ics.muni.cz:54356" <span style="color:gray;"># this is a string</span>
  topology     "BUT.stop"                       <span style="color:gray;"># this is a string</span>
   
   
  fmode          1                              <span style="color:gray;"># this is an integer number</span>
  probesize      1                              <span style="color:gray;"># this is an integer number</span>
   
   
  fbeta        10.1234                          <span style="color:gray;"># this is a real number</span>
  fbeta        10.1234                          <span style="color:gray;"># this is a real number</span>
   
   
  frestart      on                              <span style="color:gray;"># this is a logical number</span>
  enabled        on                              <span style="color:gray;"># this is a logical number</span>
group_a      :1-6@CA                          <span style="color:gray;"># this is an ASL mask</span>

Revision as of 13:18, 4 March 2019

Navigation: Documentation / Control files / Control key types

The control files contains keys and their values. Values might be one of following type:

Type Description
string This is a sequence of characters beginning with the second word on a keyword line and ending with the last word (the first word is a key). Space among words is included in the string without any modification. The whole sequence can be enclosed into quotation marks.
integer This is a sequence of number characters in a free format. Plain integer numbers as well as numbers in exponential form are supported. If the number contains the fractional part then the number is ignored and the keyword line is not marked as processed.
real This is a sequence of number characters in a free format. Plain real numbers as well as numbers in exponential form are supported.
logical This is a boolean value, which can have two values: true or false.
The true value can be entered as: on, ON, true, TRUE, T, 1
The false value can be entered as: off, OFF, false, FALSE, F, 0
Other entries are ignored and the keyword line is not marked as processed.


Examples 

topology      "BUT.stop"                       # this is a string

probesize       1                              # this is an integer number

fbeta         10.1234                          # this is a real number

enabled        on                              # this is a logical number
Retrieved from "https://ffdevel.ncbr.muni.cz/wiki/index.php?title=Control_key_types&oldid=42"