nwtc_io::parsevar Interface Reference

This subroutine parses the specified line of text for two words. More...

Public Member Functions
subroutine	parsechvar (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...
subroutine	parseinvar (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...
subroutine	parselovar (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...
subroutine	parsesivar (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...
subroutine	parser8var (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...
subroutine	parsequvar (FileInfo, LineNum, ExpVarName, Var, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

Detailed Description

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

Member Function/Subroutine Documentation

parsechvar()

subroutine nwtc_io::parsevar::parsechvar	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		character(*), intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

parseinvar()

subroutine nwtc_io::parsevar::parseinvar	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		integer, intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

parselovar()

subroutine nwtc_io::parsevar::parselovar	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		logical, intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

parsequvar()

subroutine nwtc_io::parsevar::parsequvar	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(quki), intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

parser8var()

subroutine nwtc_io::parsevar::parser8var	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(r8ki), intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

parsesivar()

subroutine nwtc_io::parsevar::parsesivar	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(siki), intent(out)	Var,
		integer(intki), intent(out)	ErrStat,
		character(*), intent(out)	ErrMsg,
		integer, intent(in), optional	UnEc
	)

This subroutine parses the specified line of text for two words.

One should be a the name of a variable and the other the value of the variable. Generate an error message if the value is the wrong type or if only one "word" is found.

WARNING: This routine assumes the "words" containing the variable name and value are <= 20 characters.
Use ParseVar (nwtc_io::parsevar) instead of directly calling a specific routine in the generic interface.

Parameters

[out]	errstat	The error status.
[in,out]	linenum	The number of the line to parse.
[in]	unec	I/O unit for echo file. If present and > 0, write to UnEc.
[out]	var	The variable to receive the input value.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

---

The documentation for this interface was generated from the following file:

• NWTC_IO.f90