Parameter Parser: Difference between revisions

From DISI
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:


In Interactive Mode, dock will dynamically ask the user to enter the appropriate user parameters. The generic format for the questions is:


    In Interactive Mode, dock will dynamically ask the user to enter the appropriate user parameters. The generic format for the questions is:
parameter_name [default value] (legal values):


        parameter_name [default value] (legal values):
The parameter parser requires that the values entered for a parameter exactly match one of the legal values. For example:


    The parameter parser requires that the values entered for a parameter exactly match one of the legal values. For example:
Example A: program_location [Hello_World!] ():


        Example A: program_location [Hello_World!] ():
Example B: #_red_balloons [99] ():


        Example B: #_red_balloons [99] ():
Example C: glass_status [half_full] (half_full half_empty):


        Example C: glass_status [half_full] (half_full half_empty):
In Example A, the parameter "program_location" can be assigned any string value, and in Example B, the parameter "#_red_balloons" can be assigned any integer value. However, in Example C, the parameter value "glass_status" can only be assigned the strings "half_full" or "half_empty". If no parameter are assigned by the user, the default value--in brackets--will be used.


    In Example A, the parameter "program_location" can be assigned any string value, and in Example B, the parameter "#_red_balloons" can be assigned any integer value. However, in Example C, the parameter value "glass_status" can only be assigned the strings "half_full" or "half_empty". If no parameter are assigned by the user, the default value--in brackets--will be used.
In Batch Mode, all parameters in the dock.in file, must be:


    In Batch Mode, all parameters in the dock.in file, must be:
parameter_name value


        parameter_name value  
Note that the parameter_name and corresponding value need to be separated by white space or a tab.


    Note that the parameter_name and corresponding value need to be separated by white space or a tab.
[[Category:Manual]]
[[Category:Docking]]
[[Category:DOCK 6]]

Latest revision as of 04:05, 14 February 2014

In Interactive Mode, dock will dynamically ask the user to enter the appropriate user parameters. The generic format for the questions is:

parameter_name [default value] (legal values):

The parameter parser requires that the values entered for a parameter exactly match one of the legal values. For example:

Example A: program_location [Hello_World!] ():
Example B: #_red_balloons [99] ():
Example C: glass_status [half_full] (half_full half_empty):

In Example A, the parameter "program_location" can be assigned any string value, and in Example B, the parameter "#_red_balloons" can be assigned any integer value. However, in Example C, the parameter value "glass_status" can only be assigned the strings "half_full" or "half_empty". If no parameter are assigned by the user, the default value--in brackets--will be used.

In Batch Mode, all parameters in the dock.in file, must be:

parameter_name value 

Note that the parameter_name and corresponding value need to be separated by white space or a tab.