Changeset 2548 in Sophya


Ignore:
Timestamp:
Jun 3, 2004, 1:52:42 PM (21 years ago)
Author:
ansari
Message:

Ajout d'un ancien fichier de description de modules + dependences de SOPHYA, datant d'Aout 2002 - Reza 3 Juin 2004

Location:
trunk/SophyaLib/Manual
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SophyaLib/Manual/piahelp.tex

    r2416 r2548  
    22List of {\bf piapp} on-line Help groups:
    33\begin{itemize}
     4\item {\bf Commander }  (p. \pageref{Commander})
    45\item {\bf CxxExecutorCmd }  (p. \pageref{CxxExecutorCmd})
    56\item {\bf Expr. Arithmetic }  (p. \pageref{ExprZZArithmetic})
     
    2627\vspace{3mm}
    2728\begin{tabular}{llllll} 
    28 Interpreter & p. \pageref{Interpreter}  & ObjectExpressions & p. \pageref{ObjectExpressions}  & PIConsole & p. \pageref{PIConsole}  \\ 
     29Commander & p. \pageref{Commander}  & ObjectExpressions & p. \pageref{ObjectExpressions}  & PIConsole & p. \pageref{PIConsole}  \\ 
    2930PIDraw3DWdg & p. \pageref{PIDraw3DWdg}  & PIImage & p. \pageref{PIImage}  & PIScDrawWdg & p. \pageref{PIScDrawWdg}  \\ 
    3031RPNEvaluator & p. \pageref{RPNEvaluator}  & Windows & p. \pageref{Windows}  & autoiniranf & p. \pageref{autoiniranf}  \\ 
    31 exitpiapp & p. \pageref{exitpiapp}  & helpfit & p. \pageref{helpfit}  & shell execute & p. \pageref{shellZexecute}  \\ 
     32exitpiapp & p. \pageref{exitpiapp}  & helpfit & p. \pageref{helpfit}  & helpwindow & p. \pageref{helpwindow}  \\ 
     33shell execute & p. \pageref{shellZexecute}  &   &  &  &   \\ 
    3234\end{tabular}
    3335\end{center}
     
    3537\vspace{6mm}
    3638\begin{center}
    37  \rule{2cm}{1mm} \makebox[60mm]{{ \bf CxxExecutorCmd } help group} \rule{2cm}{1mm} \\
     39 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Commander } help group} \rule{2cm}{0.5mm} \\
     40\vspace{3mm}
     41\begin{tabular}{llllll}
     42Commander & p. \pageref{Commander}  & RPNEvaluator & p. \pageref{RPNEvaluator}  & autoiniranf & p. \pageref{autoiniranf}  \\ 
     43shell execute & p. \pageref{shellZexecute}  &   &  &  &   \\ 
     44\end{tabular}
     45\end{center}
     46\vspace{6mm}
     47\begin{center}
     48 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf CxxExecutorCmd } help group} \rule{2cm}{0.5mm} \\
    3849\vspace{3mm}
    3950\begin{tabular}{llllll}
     
    4758\vspace{6mm}
    4859\begin{center}
    49  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Expr. Arithmetic } help group} \rule{2cm}{1mm} \\
     60 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Expr. Arithmetic } help group} \rule{2cm}{0.5mm} \\
    5061\vspace{3mm}
    5162\begin{tabular}{llllll}
     
    5566\vspace{6mm}
    5667\begin{center}
    57  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Expr. Plotting } help group} \rule{2cm}{1mm} \\
     68 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Expr. Plotting } help group} \rule{2cm}{0.5mm} \\
    5869\vspace{3mm}
    5970\begin{tabular}{llllll}
     
    6879\vspace{6mm}
    6980\begin{center}
    70  \rule{2cm}{1mm} \makebox[60mm]{{ \bf External Modules } help group} \rule{2cm}{1mm} \\
     81 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf External Modules } help group} \rule{2cm}{0.5mm} \\
    7182\vspace{3mm}
    7283\begin{tabular}{llllll}
     
    7788\vspace{6mm}
    7889\begin{center}
    79  \rule{2cm}{1mm} \makebox[60mm]{{ \bf FileIO } help group} \rule{2cm}{1mm} \\
     90 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf FileIO } help group} \rule{2cm}{0.5mm} \\
    8091\vspace{3mm}
    8192\begin{tabular}{llllll}
     
    8899\vspace{6mm}
    89100\begin{center}
    90  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Fitting } help group} \rule{2cm}{1mm} \\
     101 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Fitting } help group} \rule{2cm}{0.5mm} \\
    91102\vspace{3mm}
    92103\begin{tabular}{llllll}
     
    97108\vspace{6mm}
    98109\begin{center}
    99  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Func Plot } help group} \rule{2cm}{1mm} \\
     110 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Func Plot } help group} \rule{2cm}{0.5mm} \\
    100111\vspace{3mm}
    101112\begin{tabular}{llllll}
     
    106117\vspace{6mm}
    107118\begin{center}
    108  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Graphic-Elts } help group} \rule{2cm}{1mm} \\
     119 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Graphic-Elts } help group} \rule{2cm}{0.5mm} \\
    109120\vspace{3mm}
    110121\begin{tabular}{llllll}
     
    118129\vspace{6mm}
    119130\begin{center}
    120  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Graphics } help group} \rule{2cm}{1mm} \\
     131 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Graphics } help group} \rule{2cm}{0.5mm} \\
    121132\vspace{3mm}
    122133\begin{tabular}{llllll}
     
    133144\vspace{6mm}
    134145\begin{center}
    135  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Obj. Display } help group} \rule{2cm}{1mm} \\
     146 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Obj. Display } help group} \rule{2cm}{0.5mm} \\
    136147\vspace{3mm}
    137148\begin{tabular}{llllll}
     
    144155\vspace{6mm}
    145156\begin{center}
    146  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Object Management } help group} \rule{2cm}{1mm} \\
     157 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Object Management } help group} \rule{2cm}{0.5mm} \\
    147158\vspace{3mm}
    148159\begin{tabular}{llllll}
     
    156167\vspace{6mm}
    157168\begin{center}
    158  \rule{2cm}{1mm} \makebox[60mm]{{ \bf Objects } help group} \rule{2cm}{1mm} \\
     169 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Objects } help group} \rule{2cm}{0.5mm} \\
    159170\vspace{3mm}
    160171\begin{tabular}{llllll}
     
    168179\vspace{6mm}
    169180\begin{center}
    170  \rule{2cm}{1mm} \makebox[60mm]{{ \bf PIACmd } help group} \rule{2cm}{1mm} \\
     181 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf PIACmd } help group} \rule{2cm}{0.5mm} \\
    171182\vspace{3mm}
    172183\begin{tabular}{llllll}
    173 Interpreter & p. \pageref{Interpreter}  & RPNEvaluator & p. \pageref{RPNEvaluator}  & autoiniranf & p. \pageref{autoiniranf}  \\ 
    174 exitpiapp & p. \pageref{exitpiapp}  & shell execute & p. \pageref{shellZexecute}  &   &   \\ 
     184exitpiapp & p. \pageref{exitpiapp}  & helpwindow & p. \pageref{helpwindow}  &   &   \\ 
    175185\end{tabular}
    176186\end{center}
    177187\vspace{6mm}
    178188\begin{center}
    179  \rule{2cm}{1mm} \makebox[60mm]{{ \bf SkyMapCmd } help group} \rule{2cm}{1mm} \\
     189 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf SkyMapCmd } help group} \rule{2cm}{0.5mm} \\
    180190\vspace{3mm}
    181191\begin{tabular}{llllll}
     
    192202\vspace{6mm}
    193203\begin{center}
    194  \rule{2cm}{1mm} \makebox[60mm]{{ \bf SophyaCmd } help group} \rule{2cm}{1mm} \\
     204 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf SophyaCmd } help group} \rule{2cm}{0.5mm} \\
    195205\vspace{3mm}
    196206\begin{tabular}{llllll}
     
    200210\vspace{6mm}
    201211\begin{center}
    202  \rule{2cm}{1mm} \makebox[60mm]{{ \bf pawCmd } help group} \rule{2cm}{1mm} \\
     212 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf pawCmd } help group} \rule{2cm}{0.5mm} \\
    203213\vspace{3mm}
    204214\begin{tabular}{llllll}
     
    214224% ----- Liste des commandes dans chaque groupe -----
    215225\newpage
     226\subsection{Commander} \label{Commander}
     227Basic (generic) interpreter (class SOPHYA::Commander) builtin commands
     228 \\[2mm]  \noindent
     229\piahelpitem{Commander} \label{Commander}
     230\begin{verbatim}
     231>>> (Commander) Interpreter's keywords :
     232  > set varname string   # To set a variable, $varname
     233  > get newvarname varname # To set a newvariable, equal to $varname
     234  > setol varname patt     # Fills varname with object list
     235  > unset varname          # clear variable definition
     236  > rpneval varname RPNExpression # Reverse Polish Notation evaluation
     237  > varname = 'string string ...' # To set a variable, $varname 
     238  > varname = RPNExpression # RPN evaluation / result -> varname
     239  > echo string            # output string
     240  > echo2file filename string # Append the string to the specified file
     241  > alias name string      # define a command alias
     242  > readstdin varname      # reads a line from stdin into $varname
     243  > foreach varname ( string-list ) # Loop
     244  > for varname i1:i2[:di]      # Integer loop 
     245  > for varname f1:f2[:df]      # Float loop 
     246  > end                         # end loops
     247  > if ( test ) then  # Conditional test : a == != < > <= >= b
     248  > else          # Conditional 
     249  > endif         # End of conditional if bloc
     250  > break         # Delete (clears) all test and loop blocs
     251  > return        # Stops command execution from a file
     252  > defscript endscript # Command script definition
     253  > listvars      # List of variable names and values
     254  > listalias     # List of alias names and values
     255  > listcommands  # List of all known commands
     256  > listscripts   # List of all known scripts
     257  > clearcript    # Clear a script definition
     258  > exec filename # Execute commands from file
     259  > help <command_name>  # <command_name> usage info
     260  > timingon  timingoff traceon  traceoff
     261
     262\end{verbatim}
     263\piahelpitem{RPNEvaluator} \label{RPNEvaluator}
     264\begin{verbatim}
     265 Reverse Polish Notation (HP calculator like) expression evaluation
     266  >> Stack:
     267     ... (4) (3) z=(2) y=(1) x=(0)=Stack.Top()
     268  >> Examples: 
     269  - sin(PI/6): pi 6 / sin
     270  - 1*2*...*5: 1 2 3 4 5 product
     271  - x=x+y: x = $x $y *
     272  >>> Stack operations :
     273      print x<>y pop push (duplicate x)
     274  >>> Constants (Cst pushed to stack):
     275      pi e
     276  >>> Arithmetic operators (x,y) --> x@y
     277      + - * / % ( (int)y % (int)x )
     278  >>> F(X): x --> F(x)
     279      chs sqrt sq log log10 exp 
     280      fabs  floor ceil
     281      cos sin tan acos asin atan deg2rad rad2deg
     282  >>> F(X,Y): (x,y) --> F(x,y)
     283      pow atan2
     284  >>> F(): random number generators
     285      rand (flat 0..1) norand (normal/gaussian)
     286  >>> Stack sum/product/mean/sigma/sigma^2
     287      sum product mean sigma sigma2 sigmean (y->sigma x->mean)
     288
     289\end{verbatim}
     290\piahelpitem{autoiniranf} \label{autoiniranf}
     291\begin{verbatim}
     292> Automatic random number generator initialisation
     293   by Auto_Ini_Ranf(int lp)
     294   Usage: autoiniranf
     295\end{verbatim}
     296\piahelpitem{shell execute} \label{shellZexecute}
     297\begin{verbatim}
     298> shell  command_string  # Execute  shell command
     299> cshell command_string  # Execute cshell command
     300---Examples:
     301  > shell ls
     302  > cshell echo '$LD_LIBRARY_PATH'; map2cl -h; ls
     303  > shell myfile.csh [arg1] [arg2] [...]
     304    (where the first line of "myfile.csh" is "#!/bin/csh")
     305
     306\end{verbatim}
    216307\subsection{CxxExecutorCmd} \label{CxxExecutorCmd}
    217308\noindent
     
    470561\end{verbatim}
    471562\subsection{External Modules} \label{ExternalZModules}
    472 \noindent
     563Dynamic load (shared object modules) management command group
     564 \\[2mm]  \noindent
    473565\piacommand{call} \label{call}
    474566\begin{verbatim}
     
    9171009\end{verbatim}
    9181010\subsection{Graphics} \label{Graphics}
    919 \noindent
     1011Basic graphics and object display commands
     1012 \\[2mm]  \noindent
    9201013\piahelpitem{PIConsole} \label{PIConsole}
    9211014\begin{verbatim}
     
    14321525\end{verbatim}
    14331526\subsection{PIACmd} \label{PIACmd}
    1434 \noindent
    1435 \piahelpitem{Interpreter} \label{Interpreter}
    1436 \begin{verbatim}
    1437 >>> (piacmd) Interpreter's keywords :
    1438   > set varname string   # To set a variable, $varname
    1439   > get newvarname varname # To set a newvariable, equal to $varname
    1440   > setol varname patt     # Fills varname with object list
    1441   > unset varname          # clear variable definition
    1442   > rpneval varname RPNExpression # Reverse Polish Notation evaluation
    1443   > varname = 'string string ...' # To set a variable, $varname 
    1444   > varname = RPNExpression # RPN evaluation / result -> varname
    1445   > echo string            # output string
    1446   > echo2file filename string # Append the string to the specified file
    1447   > alias name string      # define a command alias
    1448   > readstdin varname      # reads a line from stdin into $varname
    1449   > foreach varname ( string-list ) # Loop
    1450   > for varname i1:i2[:di]      # Integer loop 
    1451   > for varname f1:f2[:df]      # Float loop 
    1452   > end                         # end loops
    1453   > if ( test ) then  # Conditional test : a == != < > <= >= b
    1454   > else          # Conditional 
    1455   > endif         # End of conditional if bloc
    1456   > break         # Delete (clears) all test and loop blocs
    1457   > return        # Stops command execution from a file
    1458   > defscript endscript # Command script definition
    1459   > listvars      # List of variable names and values
    1460   > listalias     # List of alias names and values
    1461   > listcommands  # List of all known commands
    1462   > listscripts   # List of all known scripts
    1463   > clearcript    # Clear a script definition
    1464   > exec filename # Execute commands from file
    1465   > help <command_name>  # <command_name> usage info
    1466   > helpwindow           # Displays help window
    1467   > timingon  timingoff traceon  traceoff
    1468 
    1469 \end{verbatim}
    1470 \piahelpitem{RPNEvaluator} \label{RPNEvaluator}
    1471 \begin{verbatim}
    1472  Reverse Polish Notation (HP calculator like) expression evaluation
    1473   >> Stack:
    1474      ... (4) (3) z=(2) y=(1) x=(0)=Stack.Top()
    1475   >> Examples: 
    1476   - sin(PI/6): pi 6 / sin
    1477   - 1*2*...*5: 1 2 3 4 5 product
    1478   - x=x+y: x = $x $y *
    1479   >>> Stack operations :
    1480       print x<>y pop push (duplicate x)
    1481   >>> Constants (Cst pushed to stack):
    1482       pi e
    1483   >>> Arithmetic operators (x,y) --> x@y
    1484       + - * / % ( (int)y % (int)x )
    1485   >>> F(X): x --> F(x)
    1486       chs sqrt sq log log10 exp 
    1487       fabs  floor ceil
    1488       cos sin tan acos asin atan deg2rad rad2deg
    1489   >>> F(X,Y): (x,y) --> F(x,y)
    1490       pow atan2
    1491   >>> F(): random number generators
    1492       rand (flat 0..1) norand (normal/gaussian)
    1493   >>> Stack sum/product/mean/sigma/sigma^2
    1494       sum product mean sigma sigma2 sigmean (y->sigma x->mean)
    1495 
    1496 \end{verbatim}
    1497 \piahelpitem{autoiniranf} \label{autoiniranf}
    1498 \begin{verbatim}
    1499 > Automatic random number generator initialisation
    1500    by Auto_Ini_Ranf(int lp)
    1501    Usage: autoiniranf
    1502 \end{verbatim}
     1527piapp interpreter (class PIACmd) additional builtin commands
     1528 \\[2mm]  \noindent
    15031529\piahelpitem{exitpiapp} \label{exitpiapp}
    15041530\begin{verbatim}
    1505 To end the piapp session (Interpreter's command)
    1506 \end{verbatim}
    1507 \piahelpitem{shell execute} \label{shellZexecute}
    1508 \begin{verbatim}
    1509 > shell  command_string  # Execute  shell command
    1510 > cshell command_string  # Execute cshell command
    1511 ---Examples:
    1512   > shell ls
    1513   > cshell echo '$LD_LIBRARY_PATH'; map2cl -h; ls
    1514   > shell myfile.csh [arg1] [arg2] [...]
    1515     (where the first line of "myfile.csh" is "#!/bin/csh")
    1516 
     1531To end the piapp session
     1532\end{verbatim}
     1533\piahelpitem{helpwindow} \label{helpwindow}
     1534\begin{verbatim}
     1535To display the Help window
    15171536\end{verbatim}
    15181537\subsection{SkyMapCmd} \label{SkyMapCmd}
    1519 \noindent
     15384 Pi spherical, local maps manipulation commands
     1539and spherical harmonics analysis Ylm.
     1540 This is mainly Based on SOPHYA SkyMap and Samba modules. 
     1541 \\[2mm]  \noindent
    15201542\piacommand{alm2cl} \label{alm2cl}
    15211543\begin{verbatim}
Note: See TracChangeset for help on using the changeset viewer.