#include <stdio.h>
#include <string.h>
#include <expat.h>

Include dependency graph for util/utilXml.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	Stack

Macros
#define	XML_FMT_INT_MOD "l"

#define	BUFFSIZE 8192

Typedefs
typedef struct Stack	Stack

Functions

static void XMLCALL EPstart (void *data, const char *el, const char **attr)

Call back functions that will be used by the expat xml parser. More...

static void XMLCALL EPend (void *data, const char *el)

Call back functions that will be used by the expat xml parser. More...

void freeResource (char **strArr, int n)

This method frees the local memory allocated. More...

int getepvariables (char *const fileName, char *const myOutputVarsName, char *const myOutputVarsType, int *const myNumOutputVars, char *const myInputKeys, int *const myNumInputKeys, char *const myInputVars, int *const myNumInputVars, int *const myInputVarsType, int *const myStrLen)

This method will return the input and output variable for EnergyPlus in sequence. More...

int getepvariablesFMU (char *const fileName, char *const myOutputVarsName, char *const myOutputVarsType, int *const myNumOutputVars, char *const myInputKeys, int *const myNumInputKeys, char *const myInputVars, int *const myNumInputVars, int *const myInputVarsType, int *const myStrLen)

This method will return the input and output variable for EnergyPlus in sequence. More...

int stackPopBCVTB ()

Stack operation, this function will pop one element from stack and will free the resource unused. More...

int stackPushBCVTB (char *str)

Stack operation, will push one element into the stack and will allocate memory for the new element, hence is deep copy. More...

]

Parameters

fileName	the xml file name.
exp	the xPath expression.
str	string to store the found values, semicolon separated.
nVals	number of values found.
strLen	the string length allocated.

int getxmlvalues (char *const fileName, char *const exp, char *const myVals, int *const myNumVals, int const myStrLen)

static void XMLCALL start (void *data, const char *el, const char **attr)

Call back functions that will be used by the expat xml parser. More...

static void XMLCALL end (void *data, const char *el)

Call back functions that will be used by the expat xml parser. More...

int getnumberofxmlvalues (char *const fileName, char *const exp)

int getxmlvaluesf (char *const fileName, char *const exp, char *const atrName, int *const nVal, char *const str, int *const strLen)

int getxmlvalue (char *const fileName, char *const exp, char *const str, int *const nVals, int const strLen)

int check_variable_cfg_Validate (char *const fileName)

This method checks the validity of the variables configuration xml file for a given dtd file that is specified in the variables configuration file. More...

Variables
char	Buff [BUFFSIZE]
	Local buffer for reading in the xml file. More...

Stack	expStk
	Variables for getxmlvalue function. More...

char *	att
	Local global variable for function `getxmlvalue`. More...

char *	vals
	Local global variable for function `getxmlvalue`. More...

int *	numVals
	Local global variable for function `getxmlvalue`. More...

int	PARSEVALUE
	flag for parsing xml values 1 if parse, 0 if not parse More...

int	ERROR_STATUS
	flag for xml element handler error status settings More...

char *	outputVarsName
	local global variables for function `getepvariables` More...

char *	outputVarsType
	the string pointer to the parsed output variable types More...

int *	numOutputVars
	the integer pointer to the number of output variables More...

char *	inputVars
	the string pointer to the input variables More...

int *	numInputVars
	the integer pointer to the number of input variables More...

int *	inputVarsType
	the ineger array to store the types of each input variables More...

char **	inputKeys
	the string array to store the types of input variable types More...

int	numInputKeys
	the number of input variable types More...

int	source
	flag for function /c getepvariables 0=EnergyPlus, 1=Ptolemy More...

const int *	strLen
	the length of string parsed to this function More...

Macro Definition Documentation

#define BUFFSIZE 8192

Definition at line 125 of file util/utilXml.h.

Referenced by getepvariables(), getepvariablesFMU(), and getxmlvalues().

#define XML_FMT_INT_MOD "l"

Definition at line 121 of file util/utilXml.h.

Typedef Documentation

typedef struct Stack Stack

Function Documentation

int check_variable_cfg_Validate ( char *const fileName )

This method checks the validity of the variables configuration xml file for a given dtd file that is specified in the variables configuration file.

Return values: -1 Error in the file 0 File is validate

Definition at line 869 of file util/utilXml.c.

static void XMLCALL end	(	void *	data,
		const char *	el
	)

static

Call back functions that will be used by the expat xml parser.

This function is used for getxmlvalues

static void XMLCALL EPend	(	void *	data,
		const char *	el
	)

static

Call back functions that will be used by the expat xml parser.

This function is designed for the function getepvariables to get input and output variables in the same order as they appear in the configuration file

static void XMLCALL EPstart	(	void *	data,
		const char *	el,
		const char **	attr
	)

static

Call back functions that will be used by the expat xml parser.

This function is designed for the function getepvariables to get input and output variables in the same order as they appear in the configuration file

void freeResource	(	char **	strArr,
		int	n
	)

This method frees the local memory allocated.

Parameters

strArr	1D string array to be freed
n	the size of the 1D string array

Definition at line 216 of file util/utilXml.c.

References i.

Referenced by getepvariables(), and getepvariablesFMU().

int getepvariables	(	char *const	fileName,
		char *const	myOutputVarsName,
		char *const	myOutputVarsType,
		int *const	myNumOutputVars,
		char *const	myInputKeys,
		int *const	myNumInputKeys,
		char *const	myInputVars,
		int *const	myNumInputVars,
		int *const	myInputVarsType,
		int *const	myStrLen
	)

This method will return the input and output variable for EnergyPlus in sequence.

Parameters

fileName	the variable configuration file name.
myOutputVarsName	Array to store the output variable names found.
myOutputvarsType	Array to store the output variable types found.
myNumOutputVars	Integer holder to store number of output variables found.
myInputKeys	Array to store the input variable keys.
myNumInputKeys	Integer holder to store number of input variable keys.
myInputVars	Array to store the name of input variables found.
myNumInputVars	Integer holder to store number of input variables found.
myInputVarsType	Integer array to store the corresponding input variable types in myInputVars.
myStrLen	The length of the string that is passed to this function.

Definition at line 241 of file util/utilXml.c.

int getepvariablesFMU	(	char *const	fileName,
		char *const	myOutputVarsName,
		char *const	myOutputVarsType,
		int *const	myNumOutputVars,
		char *const	myInputKeys,
		int *const	myNumInputKeys,
		char *const	myInputVars,
		int *const	myNumInputVars,
		int *const	myInputVarsType,
		int *const	myStrLen
	)

This method will return the input and output variable for EnergyPlus in sequence.

The difference with getepvariables is that it does not validate the configuration file

Parameters

fileName	the variable configuration file name.
myOutputVarsName	Array to store the output variable names found.
myOutputvarsType	Array to store the output variable types found.
myNumOutputVars	Integer holder to store number of output variables found.
myInputKeys	Array to store the input variable keys.
myNumInputKeys	Integer holder to store number of input variable keys.
myInputVars	Array to store the name of input variables found.
myNumInputVars	Integer holder to store number of input variables found.
myInputVarsType	Integer array to store the corresponding input variable types in myInputVars.
myStrLen	The length of the string that is passed to this function.