asiAddFlowchartStep
o_flowchart
[ ?name s_name ]
[ ?description t_description ]
[ ?runMessage t_runMessage ]
[ ?function s_function ]
[ ?checkFunc s_checkFunc ]
[ ?preFunc s_preFunc ]
[ ?postFunc s_postFunc ]
[ ?ignoreFunc s_ignoreFunc ]
)
=> o_step / nil
Description
Adds a new step to an existing flowchart.
Arguments
|
o_flowchart
|
Flowchart object to which you want to add a step.
|
|
?name s_name
|
Name of the step to add.
|
|
?description t_description
|
|
|
Textual description of the step.
|
|
?runMessage t_runMessage
|
|
|
Message to print when this step is executed.
|
|
?function s_function
|
The (primary) procedure to call to execute this step.
Callback parameter list: (o_session)
|
|
?checkFunc s_checkFunc
|
|
|
Function to evaluate to update the status of this step. This function is executed after the dependency requirement is met. If this function returns nil, the step function and its children are invalidated.
Callback parameter list: (o_session)
|
|
?preFunc s_preFunc
|
Function to evaluate immediately before the primary procedure, s_function is executed. It can be added to a step instance to customize an existing step.
Callback parameter list: (o_session)
|
|
?postFunc s_postFunc
|
|
|
Procedure to execute after s_function.
Callback parameter list: (o_session)
|
|
?ignoreFunc s_ignoreFunc
|
|
|
Function to skip this step. If this function returns t, this step in flowchart is not executed.
|
Value Returned
|
o_step
|
Returns the flowchart step object.
|
|
nil
|
There is an error.
|
Examples
For the XYZ simulator, add a new step to send the ABC file to Cadence SPICE.
asiAddFlowchartStep( flowchart
?name ’sendABCfile
?description "Send the ABC file"
?runMessage "sending ABC file..."
?function ’sendABCfile
)
Return to top
