input_enumeration_types Module Reference

represents an enumeration, i.e. a mapping between integers and strings More...

Data Types
type	enumeration_type

Functions/Subroutines
subroutine, public	enum_create (enum, c_vals, i_vals, desc, strict)
	creates an enumeration
subroutine, public	enum_retain (enum)
	retains the given enumeration
subroutine, public	enum_release (enum)
	releases the given enumeration
character(len=default_string_length) function, public	enum_i2c (enum, i)
	maps an integer to a string
integer function, public	enum_c2i (enum, c)
	maps a string to an integer

Detailed Description

represents an enumeration, i.e. a mapping between integers and strings

History

08.2004 created [fawzi]

Author

fawzi

Function/Subroutine Documentation

enum_create()

subroutine, public input_enumeration_types::enum_create	(	type(enumeration_type), pointer	enum,
		character(len=*), dimension(:), intent(in)	c_vals,
		integer, dimension(:), intent(in)	i_vals,
		character(len=*), dimension(:), intent(in), optional	desc,
		logical, intent(in), optional	strict
	)

creates an enumeration

Parameters

enum	the enumeration to be created
c_vals	string values
i_vals	integer values
desc	...
strict	if integer values not in the list should be accepted, defaults defaults to true

Author

fawzi

Definition at line 63 of file input_enumeration_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

enum_retain()

subroutine, public input_enumeration_types::enum_retain

(

type(enumeration_type), pointer

enum

)

retains the given enumeration

Parameters

enum	the obect to retain

Author

fawzi

Definition at line 110 of file input_enumeration_types.F.

Here is the caller graph for this function:

enum_release()

subroutine, public input_enumeration_types::enum_release

(

type(enumeration_type), pointer

enum

)

releases the given enumeration

Parameters

enum	the obect to release

Author

fawzi

Definition at line 123 of file input_enumeration_types.F.

Here is the caller graph for this function:

enum_i2c()

character(len=default_string_length) function, public input_enumeration_types::enum_i2c	(	type(enumeration_type), pointer	enum,
		integer, intent(in)	i
	)

maps an integer to a string

Parameters

enum	the enumeration to use for the mapping
i	the value to map

Returns

...

Author

fawzi

Definition at line 151 of file input_enumeration_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

enum_c2i()

integer function, public input_enumeration_types::enum_c2i	(	type(enumeration_type), pointer	enum,
		character(len=*), intent(in)	c
	)

maps a string to an integer

Parameters

enum	the enumeration to use for the mapping
c	the value to map

Returns

...

Author

fawzi

Definition at line 191 of file input_enumeration_types.F.

Here is the call graph for this function:

Here is the caller graph for this function: