Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PTP/user-guides/jaxb etfw workflow"
< PTP | user-guides
m (New page: == Overview ==) |
m |
||
| Line 1: | Line 1: | ||
| − | == Overview == | + | == Overview == |
| + | |||
| + | The intent of this user guide is to provide information on writing ETFw XML workflows using JAXB by going through the various parts of the workflow. | ||
| + | |||
| + | == Creating an ETFw Workflow == | ||
| + | |||
| + | This section will explain the parts critical parts of the XML file that represents an ETFw workflow. | ||
| + | |||
| + | === Control Data === | ||
| + | |||
| + | For those that are familiar with creating target configurations, this is probably a familiar term. The control data tag contains all of the attributes that are associated with the workflow. The attributes will be used to control UI actions and store information based on user selections. Below is a snippet from the ETFw TAU XML workflow. These attributes were selected because they illustrate how environment variables are stored, how UI options can be translated into program arguments and how a program argument can be paired with another attribute that has the value to pass in. In the next few sub-sections, each set of attributes will be explained in more detail with the corresponding XML UI code. | ||
| + | |||
| + | <source lang="XML"> | ||
| + | <controlData> | ||
| + | <!-- This is how an environment variable, TAU_SYNCHRONIZE_CLOCKS is set --> | ||
| + | <attribute name="TAU Runtime.performance.options.environmentvariables.configuration_id_TAU_SYNCHRONIZE_CLOCKS" type="boolean" translateBooleanAs="1, "> | ||
| + | <rm:default>1</rm:default> | ||
| + | </attribute> | ||
| + | <!-- This is how a program option is set, e.g. -optVerbose, which will get passed as a command line argument --> | ||
| + | <attribute name="Tau Compiler.performance.options.configuration_id_-OPTVERBOSE_ARGUMENT_DEFAULT" type="boolean" translateBooleanAs="-optVerbose, "> | ||
| + | <rm:description>Turn on verbose debugging message</rm:description> | ||
| + | <rm:tooltip>Turn on verbose debugging message</rm:tooltip> | ||
| + | <rm:default> </rm:default> | ||
| + | </attribute> | ||
| + | <!-- These last two attributes contain the program argument, -optPdtDir=, and the value to set it equal to --> | ||
| + | <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT" type="boolean" translateBooleanAs="-optPdtDir=, "> | ||
| + | <rm:description></rm:description> | ||
| + | <rm:tooltip></rm:tooltip> | ||
| + | <rm:default> </rm:default> | ||
| + | </attribute> | ||
| + | <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT_SAVED" type="string"> | ||
| + | <rm:default></rm:default> | ||
| + | </attribute> | ||
| + | </controlData> | ||
| + | </source> | ||
Revision as of 16:59, 19 December 2012
Overview
The intent of this user guide is to provide information on writing ETFw XML workflows using JAXB by going through the various parts of the workflow.
Creating an ETFw Workflow
This section will explain the parts critical parts of the XML file that represents an ETFw workflow.
Control Data
For those that are familiar with creating target configurations, this is probably a familiar term. The control data tag contains all of the attributes that are associated with the workflow. The attributes will be used to control UI actions and store information based on user selections. Below is a snippet from the ETFw TAU XML workflow. These attributes were selected because they illustrate how environment variables are stored, how UI options can be translated into program arguments and how a program argument can be paired with another attribute that has the value to pass in. In the next few sub-sections, each set of attributes will be explained in more detail with the corresponding XML UI code.
<controlData> <!-- This is how an environment variable, TAU_SYNCHRONIZE_CLOCKS is set --> <attribute name="TAU Runtime.performance.options.environmentvariables.configuration_id_TAU_SYNCHRONIZE_CLOCKS" type="boolean" translateBooleanAs="1, "> <rm:default>1</rm:default> </attribute> <!-- This is how a program option is set, e.g. -optVerbose, which will get passed as a command line argument --> <attribute name="Tau Compiler.performance.options.configuration_id_-OPTVERBOSE_ARGUMENT_DEFAULT" type="boolean" translateBooleanAs="-optVerbose, "> <rm:description>Turn on verbose debugging message</rm:description> <rm:tooltip>Turn on verbose debugging message</rm:tooltip> <rm:default> </rm:default> </attribute> <!-- These last two attributes contain the program argument, -optPdtDir=, and the value to set it equal to --> <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT" type="boolean" translateBooleanAs="-optPdtDir=, "> <rm:description></rm:description> <rm:tooltip></rm:tooltip> <rm:default> </rm:default> </attribute> <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT_SAVED" type="string"> <rm:default></rm:default> </attribute> </controlData>