<!--
(C) Copyright 1996-2016 ECMWF.
This software is licensed under the terms of the Apache Licence Version 2.0
which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
In applying this licence, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation nor
does it submit to any jurisdiction.
-->
<magics>
	<class directory="drivers"
		prefix="output"
		xmltag="driver"
		name="BaseDriver"
		abstract="yes">
		<documentation for_docs="no">
  These parameters are common to all the output drivers and can be used whichever output format is selected.
		</documentation>
		<parameter member="title"
			to="string"
			default="Magics plot"
			from="string"
			name="output_title">
			<documentation>Defines a title for the output which gets displayed if the format supports it.</documentation>
		</parameter>
		<parameter member="file"
			to="string"
			default=""
			from="string"
			name="output_file">
			<documentation>Defines the name of the output file. The file extension is used to select the format.</documentation>
		</parameter>
		<parameter member="name"
			to="string"
			default=""
			from="string"
			name="output_name">
			<documentation>Defines the root of output filename.</documentation>
		</parameter>
		<parameter member="firstnumber"
			to="bool"
			default="on"
			from="string"
			name="output_name_first_page_number">
			<documentation>Determines whether, for the first page of multipage output, the number is included in the filename.</documentation>
		</parameter>
		<parameter member="firstvalue"
			to="int"
			default="1"
			from="int"
			name="output_name_first_page_number_value">
			<documentation>Sets the number of the first page. All other pages are number from this value onwards.</documentation>
		</parameter>
		<parameter member="fullname"
			to="string"
			default=""
			from="string"
			name="output_fullname">
			<documentation>Alternative way of specifying the output filename. Will be overwritten by output_name if defined.</documentation>
		</parameter>
		<parameter from="string"
			name="output_legacy_name"
			visible="no"
			default=""
			member="legacyname"
			to="string">
			<documentation>Alternative way of specifying the output filename. Will be overwritten by output_name if defined.</documentation>
		</parameter>
		<parameter member="numberingwidth"
			to="int"
			default="1"
			from="int"
			name="output_file_minimal_width">
			<documentation>Width of numbering of multi-file outputs (eg, 'plot.1.png' or 'plot.001.png').</documentation>
		</parameter>
		<parameter member="separator"
			to="string"
			default="."
			from="string"
			name="output_file_separator">
			<documentation>Defines the separator between root name and the page number. Default is a dot.</documentation>
		</parameter>
		<parameter from="string"
			name="output_creator"
			visible="no"
			default=""
			member="output_creator"
			to="string">
			<documentation for_docs="no">Option for software using magics to put their name and version.</documentation>
			<release>2.27.0</release>
		</parameter>
		<parameter from="string"
			name="output_mgb_template"
			visible="no"
			default=""
			member="mgb_template"
			to="string">
			<documentation for_docs="no">Path to the magics binary file to be used as a template</documentation>
		</parameter>
		<parameter member="debug"
			to="bool"
			default="off"
			from="string"
			name="output_debug">
			<documentation>Defines if extra debug information are written in the output file (PS, EPS, SVG) or console (PNG).</documentation>
			<release>2.1</release>
		</parameter>
		<parameter member="width"
			to="int"
			default="800"
			from="int"
			name="output_width">
			<documentation>Defines the width of the image in pixels.(For GD and SVG)</documentation>
		</parameter>
		<!--
	<parameter member="resolution" to="int" default="300" from="int" name="output_resolution">
  		<documentation>Defines the resolution of the (graphical) output in dpi (72 - screen, 300 - print).</documentation>
	</parameter>
-->
		<parameter member="filelist"
			to="bool"
			default="off"
			from="string"
			name="output_filelist">
			<documentation>Defines if a list of all generated files should be written.</documentation>
			<set name="output_filelist_name" value="on"></set>
			<release>2.7.10</release>
		</parameter>
		<parameter member="filelist_name"
			to="string"
			default="magics_outputs.lst"
			from="string"
			name="output_filelist_name">
			<documentation>Defines the name of the file containing the list of generated files.</documentation>
			<release>2.7.10</release>
		</parameter>
		<parameter name='output_filelist_reset'
			from='string'
			to='bool'
			member='filelist_reset'
			default='off'>
			<documentation>Defines if the file containing the list of generated files is started from scratch or appends to previous file.</documentation>
			<release>2.24.1</release>
		</parameter>
		<parameter from="intarray"
			name="output_frame_list"
			visible="no"
			default="intarray()"
			member="frame_list"
			to="intarray">
			<documentation for_docs="no">Defines the list of frames to plot ( if empty, all the frames will be plotted!).</documentation>
		</parameter>
	</class>
</magics>
