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

Public Member Functions
subroutine	parsechvarwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

subroutine	parseinvarwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

subroutine	parselovarwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

subroutine	parsesivarwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

subroutine	parser8varwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, ErrStat, ErrMsg, UnEc)
	This subroutine parses the specified line of text for two words. More...

subroutine	parsequvarwdefault (FileInfo, LineNum, ExpVarName, Var, VarDefault, 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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[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

◆ parsechvarwdefault()

subroutine nwtc_io::parsevarwdefault::parsechvarwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		character(*), intent(out)	Var,
		character(*), intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

◆ parseinvarwdefault()

subroutine nwtc_io::parsevarwdefault::parseinvarwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		integer(intki), intent(out)	Var,
		integer(intki), intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

◆ parselovarwdefault()

subroutine nwtc_io::parsevarwdefault::parselovarwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		logical, intent(out)	Var,
		logical, intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

◆ parsequvarwdefault()

subroutine nwtc_io::parsevarwdefault::parsequvarwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(quki), intent(out)	Var,
		real(quki), intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

◆ parser8varwdefault()

subroutine nwtc_io::parsevarwdefault::parser8varwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(r8ki), intent(out)	Var,
		real(r8ki), intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[out]	errmsg	The error message, if ErrStat /= 0.
[in]	expvarname	The expected variable name.
[in]	fileinfo	The derived type for holding the file information.

◆ parsesivarwdefault()

subroutine nwtc_io::parsevarwdefault::parsesivarwdefault	(	type (fileinfotype), intent(in)	FileInfo,
		integer(intki), intent(inout)	LineNum,
		character(*), intent(in)	ExpVarName,
		real(siki), intent(out)	Var,
		real(siki), intent(in)	VarDefault,
		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 a value for the variable. If the variable is the character string "DEFAULT", a default value will be used to set 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 ParseVarWDefault (nwtc_io::parsevarwdefault) 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.
[in]	vardefault	The default value for the variable.
[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

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ parsechvarwdefault()

◆ parseinvarwdefault()

◆ parselovarwdefault()

◆ parsequvarwdefault()

◆ parser8varwdefault()

◆ parsesivarwdefault()