XMLinput.m File Reference

This function is an input filter that parses XML file and fills up the parameter structures necessary to initialize EQuUs classes. More...

Go to the source code of this file.

Functions
function	createAtom (theNode, param_structure)
	This function creates a structure Atom consisting of the atomic data of the sites. More...
function	createLeadNode (theNode, Leads)
	This function fills up data from one particular lead node. More...
function	createShape (theNode, param_structure)
	This function creates structure shape for the scattering region. More...
function	parseAttributes (theNode)
	This function parses the attributes of the XML node. More...
function	parseXML (filename)
	This opens the XML file and fills up the parameter structures. More...
function	setComputingParameters (theNode)
	This function sets computing parameters in the structure Opt. More...
function	setDefaults ()
	This function sets default values to the parameter structures. More...
function	setLeadParameters (theNode)
	This function sets parameters of the Leads. More...
function	setOptValue (attributes, attribname)
	This sets a value for a field in the Opt structure. More...
function	setParamValue (param_structure, node)
	This function sets a value for a field in the #param_structure. More...
function	setScatterParameters (theNode)
	This function sets parameters for the scattering region. More...
function	traverseNodes (theNode)
	This function parses over the attributes of the tree node. More...
function	XMLinput (filename)
	This function is an input filter that parses XML file and fills up the parameter structures necessary to initialize EQuUs classes. More...

Detailed Description

This function is an input filter that parses XML file and fills up the parameter structures necessary to initialize EQuUs classes.

Definition in file XMLinput.m.

Function Documentation

createAtom()

function createAtom	(	theNode	,
		param_structure
	)

This function creates a structure Atom consisting of the atomic data of the sites.

Parameters

theNode

A node of an XML DOM.

Returns

Returns with the modificated parameter structure

createLeadNode()

function createLeadNode	(	theNode	,
		Leads
	)

This function fills up data from one particular lead node.

Parameters

theNode	A node of an XML DOM.
Leads	A cell array of lead parameters.

Returns

Returns with the updated cell array of lead parameters.

createShape()

function createShape	(	theNode	,
		param_structure
	)

This function creates structure shape for the scattering region.

Parameters

theNode

A node of an XML DOM.

Returns

Returns with the modificated parameter structure

parseAttributes()

function parseAttributes

(

theNode

)

This function parses the attributes of the XML node.

Parameters

theNode

An instance of XML DOM node.

Returns

Returns with the structure of the extracted parameters

parseXML()

function parseXML

(

filename

)

This opens the XML file and fills up the parameter structures.

Parameters

filename

A string containing the filename of the XML file.

setComputingParameters()

function setComputingParameters

(

theNode

)

This function sets computing parameters in the structure Opt.

Parameters

theNode

An instance of XML DOM node.

setDefaults()

function setDefaults

(

)

This function sets default values to the parameter structures.

setLeadParameters()

function setLeadParameters

(

theNode

)

This function sets parameters of the Leads.

Parameters

theNode

A node of an XML DOM.

Returns

Returns with a cell array of lead parameters

setOptValue()

function setOptValue	(	attributes	,
		attribname
	)

This sets a value for a field in the Opt structure.

Parameters

attributes	A sata structure extracted from the XML DOM node.
attribname	String of the attribute name to be set

setParamValue()

function setParamValue	(	param_structure	,
		node
	)

This function sets a value for a field in the #param_structure.

Parameters

param_structure	Data structure containing the physical parameters
node	An instance of XML DOM node.

Returns

Returns with the updated structure of parameters

setScatterParameters()

function setScatterParameters

(

theNode

)

This function sets parameters for the scattering region.

Parameters

theNode

An instance of XML DOM node.

traverseNodes()

function traverseNodes

(

theNode

)

This function parses over the attributes of the tree node.

Parameters

theNode

An instance of XML DOM node.

XMLinput()

function XMLinput

(

filename

)

This function is an input filter that parses XML file and fills up the parameter structures necessary to initialize EQuUs classes.

Parameters

filename

A string containing the filename of the XML file.

Returns

[1] An instance of structure Opt

[2] An instance of structure param