CUBE Voyager

Syntax and Structure:

All statements follow the same general structure:

Some KEYWORDs automatically invoke the associated COMMAND

KEYWORDs are always followed by an equal sign and a VALUE

The VALUE may be the result of an expression or computation

E.g.:  

Continuation characters (commas, equals signs, any operator) distribute statements across multiple lines

    E.g.:

Inputs and Outputs Syntax

Expressions

Operators:

+            addition                                          ||                         logical OR
-             subtraction                                    &&                       logical AND
*            multiplication                                ==, =                    equals
/             division                                           !=, <>                  does not equal
%           modulus                                          >=                        greater than or equal to
^                           exponentiation               <=                        less than or equal to
()            parentheses                                   >                           greater than
                                                                        <                           less than

Numeric functions:
ABS, INT, ROUND, MAX, MIN, EXP, LN, LOG, POW, SQRT, RAND, RANDOM, RANDSEE

Trigonometric functions:
COS, ARCCOS, SIN, ARCSIN, TAN, ARCTAN, …

Special functions:

CmpNumRetNum(V1,OP,V2,R1,R2) = compare V1 with V2 through OP (Operator) and return R1 if true or R2 if false

Commands used in all modules

• COMP var = expression (usually without explicit COMP)
• IF (condition)
  …
  ELSEIF (condition)
   …
  ELSE
   …
  ENDIF
• LOOP… ENDLOOP
• LOOKUP
• PRINT LIST= a, b, c; where a, b, and c are variables or expressions
  • FORM = w.d; where w is the default width and d is the number of decimals
  • FILE = filename or PRINTO=#
  • CSV = T; automatically format as comma-separated values

Job Script Editor

Generated Script Files

• Script files are created and maintained by Application Manager (AM)
• If “Default Template” is chosen, Application Manager automatically generate the basic structure for the specific module/program inside the script file
• Application Manager keeps track of all the input and output files
• The user will add Parameters, Process blocks, Calculations
• The user should NEVER edit the file names and locations in the script! All changes to the file names and locations should be done in Application Manager
• NEVER have your script file open when you are linking new files into a Voyager Module. Input and output files will not get updated!

Window Layout

Code Assistant

Autocomplete

Hint: {+Cntr+space to show catalog keys

Comments

• Comment is any text following a ;  (on the same line)
  • may be at start of line
  • may be midway through a line
  • may be midway through a command

Example:

                             A=1       ;command followed by comment

                                           ;comment line here

• Block comment: enclosed by backslash and star /*    …   */
  • Cube Text Editor allows to easily collapse such comment groups (minus sign)
  • Example

                             A=1 /* comments start here…

                              …

                              … comments end here */

                            B=2

    Hint: Include plenty of comments for yourself and others

Print File Output – PRINTO

The print file must be specified as below:

• FILEO PRINTO[#] =“file name”

The variable to be printed must be stated as below:

• PRINT PRINTO=# LIST=name1(w.d), …

              Where w = variable total width and d = decimal digits

• CSV=T    --> print in CSV format

 

Good to know:

"\n"— new line control

"\f" — new page control

"\t" — tab control

"\\" — ignore new line control

Markers

 

Tip: Put Markers in big scripts for referencing.

Indentation

Indentation makes the script more readable

Status on Task Monitor

• Use PRINT PRINTO=0 to view the status on Task Monitor

Break Scripts into Subsequent Steps

• Instead of using many loops in one script often better to break scripts amongst different steps, each one undertaking an "independent task":
  • More efficient
  • Easier to be interpreted (more readable)
  • (compromise between i/o and disk consumption)

Aggregate COMP Statements

• Write COMP (implicit) statements in the same line to
  • Reduce script length
  • Improve readability

"_" Underscore Temporary Variables

• When processing temporary variables or arrays it is common practice to use "_" at the beginning of the variable name (e.g. _variable=…)
• For some programs, the "_" prevent writing the variable in the output and reset the variable every iteration (e.g. Network)