[Casa-framework] Structure of XML files

[Wes Young]

Greetings,

Here's a sketch of the layout of a Tool XML file. I will go ahead and  
fill out more detail in the next week or so. This may be found on the  
twiki at:

https://wikio.nrao.edu/bin/view/Software/ 
Implementation#XML_Layout_of_tool_task_interfac

wes
wyoung at aoc.nrao.edu

----

Example of typical tool structure

<tool name="mytool" module="mymodule">

<code>
<include>myproj/mymodule/mytool_forward.h</include>
<private>
#include &lt;myproj/mymodule/mtool_private.h&gt;
</private>
</code>

<shortdescription>
</shortdescription>
<description>
<description>

<!Methods now follow>

<method type="function" name="mymethod">
      <shortdescription>
      </shortdescription>
      <description>
      </description>
      <output>
         <param></param>
         ......
      </output>
      <inout>
         <param></param>
         ......
      </inout>
      <input>
           <param  type="" name="">
                 <description></description>
                 <value></value>
           </param>
           .....
       </input>
       <returns></returns>
       <example>
       </example>
</method>
....
</tool>

Notes:

Parameter blocks are repeated as necessary inside input, output, and  
inout blocks. Method blocks are repeated as necessary inside the tool  
block.  For a task, replace tool with task, and leave out the method  
block.

You may return tools, but not include them in the input, output, or  
inout blocks.

parameter types are bool, int, double, complex, string, boolArray,  
doubleArray, intArray, complexArray, stringArray, or any. If you  
specify the any type, you must then add an <any type=""/> tag inside  
the param block.  types, can be record or variant.  The record type  
keyword-value pairs, the variant type is used for arguments with  
unknown types.