\input manualMacros.tex
\manBegin
\manPageInfo{RCCL Reference Manual}{}{}
\manTitle{rcclSetSimulator}{3}
\manSection{NAME}
{\rightskip=0ptplus1fil
{\tt \manName{rcclSetSimulator}},
{\tt \manName{rcclGetSimulator}}
-- set simulator for an RCCL program.

}
\manSection{USAGE}
\cverbatim
#include <rccl.h>

rcclSetSimulator(simAddr)
  const char *simAddr;

char *rcclGetSimulator();
@endcverbatim
\manSection{ARGUMENTS}
\manItem{{\tt addr} --}
String specifying which simulator the program should try and
connect to.
\manSection{RESTRICTIONS}
These routines must be called from the planning level. To be
effective, {\tt rcclSetSimulator()} must also be called before the first call
to {\tt rcclCreate()}.
\manSection{DESCRIPTION}
{\tt rcclSetSimulator()} can be used to make an RCCL program run
in simulation mode. Its effect is similar to calling
{\tt rcclSetOptions(RCCL_SIMULATE)}, but it also allows
the simulator program to be explicitly specified.

{\tt rcclSetSimulator()} in fact calls {\tt rcclSetOptions(RCCL_SIMULATE)},
unless {\tt simAddr} is {\tt NULL}, in which case it calls
{\tt rcclClearOptions(RCCL_SIMULATE)}. In addtion to this, {\tt simAddr}
can be used to specify the desired simulator program.
For a description of the format used by {\tt simAddr},
see {\tt simAddress(5)}.

{\tt rcclGetSimulator()} returns the simulator address most
recently specified by {\tt rcclSetSimulator()}.
\manSection{DIAGNOSTICS}
{\tt rcclSetSimulator()} returns {\tt -1} in the event of an error, 
although no errors are currently implemented. An error condition
may be implemented in the future for passing an illegal {\tt simAddr} 
string.

These routines will abort the program if called from the control level.
\manSection{SEE ALSO}
\rightskip=0ptplus1fil
rcclSetOptions(3).

\manEnd
\end
