simInitRunDir

simInitRunDir(
) 
=> t / nil

Description

Executes the list of functions specified by the variable simInitRunActions. If this variable is not set then simInitControl and simInitRaw are the default list of functions to be executed in this order, which initializes a simulation run directory.

If these functions do not provide the correct sequence of steps to be performed for a particular simulator, the variable can be set in the simulator-specific file.

If the variable simInitRunActions has not already been set, it is set as follows:

   '(simInitControl ( )
      simInitRaw( )
   )

The file is stored in the directory local/si/caplib and has the same name as the simulator with the .ile suffix, either inside the file outside of any function, or in the function of the same name as the simulator.

Next, each function specified in the list simInitRunActions is called in the given order. As soon as one of these functions returns a value other than t, the initialization is stopped, and nil is returned. If all the functions return t, t is returned.

The function is defined in /etc/skill/si/caplib/init.ile.

Arguments

None

Value Returned

t	The command is successful.
nil	The command was unsuccessful.

Examples

simInitRunDir() 

Related Topics

OSS Functions

Return to top