Difference between revisions of "Undocumented Custom Task"

From OSUPDOCS
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
If a [[MPM Input Files#Custom Tasks|custom task]] is available but is unknown to [[NairnFEAMPM]] or [[NairnFEAMPM]], you can still use such tasks in scripted input simply by selecting them with
If a [[MPM Input Files#Custom Tasks|custom task]] is available but is unknown to [[NairnFEAMPM]] or [[NairnFEAMPMViz]], you can still use such tasks.
In scripted files, an unknown custom task name <tt>NewTask</tt> is scheduled using the commands


files by adding them with an [[XMLData Command|<tt>XMLData</tt> command block]]. The template for submitting undocumented custom tasks is:
CustomTask NewTask
Parameter Param1,(value1)
    . . .


XMLData,CustomTasks
where you provide name of the task and its parameters as required by the task. The name and parameters are all case sensitive (in contrast to known tasks, which may be tolerant of different cases). In <tt>XML</tt> files, an unknown task is scheduled using a <tt>Schedule</tt> element, which must be within the single <tt><CustomTasks></tt> block:
    <Schedule name='Task Name'>
      <Parameter name='param 1'>2</Parameter>
      <Parameter name='param 2'>10</Parameter>
    </Schedule>
EndXMLData


where you enter the name of the task in the <tt><Schedule></tt> command and list all parameters needed by that task in subordinate <tt>Parameter</tt> commands. This approach is useful for user-written custom tasks or when first [[Writing a Custom Task|developing a custom task]].
<Schedule name='newTask'>
    <Parameter name='Param1'>(value2)</Parameter>
        . . .
</Schedule>
 
The use of unknown custom tasks allows you to implement user-written custom tasks. For more details on writing custom tasks, see the help on [[Writing a Custom Task|developing a custom task]].

Latest revision as of 12:44, 2 June 2015

If a custom task is available but is unknown to NairnFEAMPM or NairnFEAMPMViz, you can still use such tasks. In scripted files, an unknown custom task name NewTask is scheduled using the commands

CustomTask NewTask
Parameter Param1,(value1)
    . . .

where you provide name of the task and its parameters as required by the task. The name and parameters are all case sensitive (in contrast to known tasks, which may be tolerant of different cases). In XML files, an unknown task is scheduled using a Schedule element, which must be within the single <CustomTasks> block:

<Schedule name='newTask'>
   <Parameter name='Param1'>(value2)</Parameter>
        . . .
</Schedule>

The use of unknown custom tasks allows you to implement user-written custom tasks. For more details on writing custom tasks, see the help on developing a custom task.