asiWriteOceanScript
asiWriteOceanScript(
p_filePointer
o_session
[ ?noRun g_noRun ]
[ ?fullKey g_fullKey ]
[ ?calledFromCorners g_calledFromCorners ]
)
=> t / nil
Description
Writes the OCEAN script.
Arguments
|
p_filePointer
|
Name of the file pointer, which was opened by calling asiOpenOceanScript.
|
|
o_session
|
Current session.
|
|
?noRun g_noRun
|
Flag to determine if the run() command and any post-processing plots should be written to the OCEAN script. For example, this flag may be used with a tool that has its own run() command.
|
|
?fullKey g_fullKey
|
Flag to determine if the default values should be written to the OCEAN script.
|
|
?calledFromCorners g_calledFromCorners
|
|
|
Flag to determine whether or not the model file information is to be written to the OCEAN script generated from the Corners tool. By default, it is set to nil, so no model file information is written to the OCEAN script generated from the Corners tool.
|
Value Returned
|
t
|
Returns t if the OCEAN script was written successfully.
|
|
nil
|
Returns nil if there was an error.
|
Examples
Writes the current session’s commands to the OCEAN script if the .cdsenv variable saveDefaultsFlag is nil. Otherwise, writes all commands (used as well as unused) to the OCEAN script.
saveDefaultsFlag=envGetVal(“asimenv.misc” “saveDefaultsToOCEAN” )
asiWriteOceanScript( fp session ?fullKey saveDefaultsFlag )
Writes the current session’s commands to the OCEAN script.
asiWriteOceanScript( fp session)
Writes the OCEAN script without adding run() and plots to the end.
asiWriteOceanScript( fp session ?noRun t)
Return to top
