Writing a Custom Task - Revision history

Nairnj: /* Task Parameters */

2015-06-11T20:15:46Z

Task Parameters

← Older revision		Revision as of 20:15, 11 June 2015
Line 17:		Line 17:

	; <tt>char CustomTask::InputParam(char pName,int &input,double &gScaling)</tt>		; <tt>char CustomTask::InputParam(char pName,int &input,double &gScaling)</tt>
	: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.<br>    The <tt>gScaling</tt> parameter is used by old custom tasks to allow them to work with both Legacy units and the new [[ConsistentUnits Command\|~~Consisten~~ units mode]]. New custom tasks should not need to use this parameter. They should assume consistent units.		: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.<br>    The <tt>gScaling</tt> parameter is used by old custom tasks to allow them to work with both Legacy units and the new [[ConsistentUnits Command\|Consistent units mode]]. New custom tasks should not need to use this parameter. They should assume consistent units.
	; <tt>void CustomTask::SetTextParameter(char *value)</tt>		; <tt>void CustomTask::SetTextParameter(char *value)</tt>
	: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>		: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>

Nairnj: /* Task Parameters */

2015-06-11T20:15:28Z

Task Parameters

← Older revision		Revision as of 20:15, 11 June 2015
Line 17:		Line 17:

	; <tt>char CustomTask::InputParam(char pName,int &input,double &gScaling)</tt>		; <tt>char CustomTask::InputParam(char pName,int &input,double &gScaling)</tt>
	: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.<br>    The <tt>gScaling</tt> parameter is used by old custom tasks to allow them to work with both Legacy units and the new [[~~ConsistenUnits~~ Command\|Consisten units mode]]. New custom tasks should not need to use this parameter. They should assume consistent units.		: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.<br>    The <tt>gScaling</tt> parameter is used by old custom tasks to allow them to work with both Legacy units and the new [[ConsistentUnits Command\|Consisten units mode]]. New custom tasks should not need to use this parameter. They should assume consistent units.
	; <tt>void CustomTask::SetTextParameter(char *value)</tt>		; <tt>void CustomTask::SetTextParameter(char *value)</tt>
	: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>		: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>

Nairnj: /* Task Parameters */

2015-06-11T20:14:43Z

Task Parameters

← Older revision		Revision as of 20:14, 11 June 2015
Line 16:		Line 16:
	If the custom task has parameters, implement them by reading them with:		If the custom task has parameters, implement them by reading them with:

	; <tt>char CustomTask::InputParam(char pName,int &input)</tt>		; <tt>char CustomTask::InputParam(char pName,int &input,double &gScaling)</tt>
	: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.		: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.<br>    The <tt>gScaling</tt> parameter is used by old custom tasks to allow them to work with both Legacy units and the new [[ConsistenUnits Command\|Consisten units mode]]. New custom tasks should not need to use this parameter. They should assume consistent units.
	; <tt>void CustomTask::SetTextParameter(char *value)</tt>		; <tt>void CustomTask::SetTextParameter(char *value)</tt>
	: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>		: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>

Nairnj: /* Task Parameters */

2015-06-02T20:03:05Z

Task Parameters

← Older revision		Revision as of 20:03, 2 June 2015
Line 17:		Line 17:

	; <tt>char CustomTask::InputParam(char pName,int &input)</tt>		; <tt>char CustomTask::InputParam(char pName,int &input)</tt>
	: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. ~~This is the only~~ method ~~that~~ does not return <tt>nextTask</tt>. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.		: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. Note that this method does not return <tt>nextTask</tt> because it needs to return a pointer. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.
	; <tt>void CustomTask::SetTextParameter(char *value)</tt>		; <tt>void CustomTask::SetTextParameter(char *value)</tt>
	: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error.		: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error. Note that this method does not return <tt>nextTask</tt>

	== Initialize ==		== Initialize ==

Nairnj: /* Task Parameters */

2015-06-02T20:01:32Z

Task Parameters

← Older revision		Revision as of 20:01, 2 June 2015
Line 17:		Line 17:

	; <tt>char CustomTask::InputParam(char pName,int &input)</tt>		; <tt>char CustomTask::InputParam(char pName,int &input)</tt>
	: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of ~~pointer needed~~ and return ~~the actual~~ pointer to the class variable for that parameter. If ~~no match~~ return <tt>NULL</tt>. This is the only method that does not return <tt>nextTask</tt>.		: Check the parameter name in <tt>pName</tt>. If it matches a defined task parameter name set <tt>input</tt> to the kind of parameter and return a pointer to the class variable for that parameter. If <tt>pName</tt> is not a valid parameter name return <tt>NULL</tt>. This is the only method that does not return <tt>nextTask</tt>. Custom tasks support three types of parameters - doubles, ints, and text strings. For doubles and ints, set <tt>input</tt> to <tt>DOUBLE_NUM</tt> or <tt>INT_NUM</tt>, respectively, and return pointer to the double or int variable to receive value for that parameter. For text strings, set <tt>input</tt> to <tt>TEXT_PARAMETER</tt> and return any non-NULL pointer. When the text string is read, this custom tasks will be called through the <tt>SetTextParameter()</tt> function.
			; <tt>void CustomTask::SetTextParameter(char *value)</tt>
			: To allow text parameters, the <tt>InputParam()</tt> function should set <tt>input</tt> to <tt>TEXT_PARAMETER</tt>. This setting will be immediately followed by a call to this method where the text for the parameter to be processed is in value. Note that this function does not transfer the name of the parameter. Thus, the class may need to set some variable in <tt>InputParam()</tt> to allow this method to know which parameter is being processed. Values of text parameters are guaranteed to be called immediately after the <tt>InputParam()</tt> call that selects them. If the text parameter is not valid, this method can call <tt>ThrowSAXException()</tt> to signal the error.

	== Initialize ==		== Initialize ==

Nairnj: /* Basic Steps */

2014-09-04T17:52:57Z

Basic Steps

← Older revision		Revision as of 17:52, 4 September 2014
Line 10:		Line 10:
	** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element		** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element
	** ''This change should be the only change made to the core code''.		** ''This change should be the only change made to the core code''.
	* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any methods that are not needed can be omitted because the <tt>CustomTask</tt> class provides methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.		* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any methods that are not needed can be omitted because the <tt>CustomTask</tt> class provides place-holder methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.

	== Task Parameters ==		== Task Parameters ==

Nairnj: /* Basic Steps */

2014-09-04T17:52:29Z

Basic Steps

← Older revision		Revision as of 17:52, 4 September 2014
Line 10:		Line 10:
	** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element		** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element
	** ''This change should be the only change made to the core code''.		** ''This change should be the only change made to the core code''.
	* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any that are not needed can be omitted because the <tt>CustomTask</tt> class provides methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.		* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any methods that are not needed can be omitted because the <tt>CustomTask</tt> class provides methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.

	== Task Parameters ==		== Task Parameters ==

Nairnj: /* Basic Steps */

2014-09-04T17:51:57Z

Basic Steps

← Older revision		Revision as of 17:51, 4 September 2014
Line 9:		Line 9:
	** See code section that handles the <tt>Schedule</tt> element		** See code section that handles the <tt>Schedule</tt> element
	** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element		** Create new instance of your task as determined by the <tt>name</tt> attribute of <tt>Schedule</tt> element
	** This change should be the only change ~~done~~ to the core code.		** ''This change should be the only change made to the core code''.
	* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any that are not needed can be omitted because the <tt>CustomTask</tt> class provides methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.		* Support methods listed below (as needed) in the new custom task. Most methods return the <tt>nextTask</tt> because the calling code uses it when it loops over all custom tasks. Any that are not needed can be omitted because the <tt>CustomTask</tt> class provides methods that simply returns the <tt>nextTask</tt>. Custom tasks are done at the end of each time step and handled by the <tt>RunCustomTasksTask</tt> class.

Nairnj at 17:51, 4 September 2014

2014-09-04T17:51:03Z

← Older revision		Revision as of 17:51, 4 September 2014
Line 1:		Line 1:
	This page explains how to create a new [[MPM Input Files#Custom Tasks\|custom task]] and integrate it into [[NairnMPM]]. Custom tasks can be used to add many new features to the code, including ~~now~~ ways to export results for visualization.		This page explains how to create a new [[MPM Input Files#Custom Tasks\|custom task]] and integrate it into [[NairnMPM]]. Custom tasks can be used to add many new features to the code, including new ways to export results for visualization.

	== Basic Steps ==		== Basic Steps ==

Nairnj: /* Custom Task Calculations */

2014-09-04T17:50:32Z

Custom Task Calculations

← Older revision		Revision as of 17:50, 4 September 2014
Line 56:		Line 56:
	;<tt>CustomTask *MyTask::StepCalculation(void)</tt>		;<tt>CustomTask *MyTask::StepCalculation(void)</tt>
	: Do the desired calculations. The code will have access to all global variables.		: Do the desired calculations. The code will have access to all global variables.

	=== Custom Task Clean Up ===		=== Custom Task Clean Up ===