signal_dot Module Reference

Defines the base class of type signal_dot_file. This module contains common code used in parsing diagnostic dot files. The actual parsing of the diagnostic dot file is handled by ipch_dot, thscte_dot and sxrch_dot. More...

Data Types
type	signal_dot_file
	Base class representing a diagnostic dot file. This is an opaqe class. More...

Functions/Subroutines
type(signal_dot_file) function, public	signal_dot_open (file, signal_id)
	Open a diagnostic dot file. More...
subroutine, public	signal_dot_close (signal_dot_file_ref)
	Close a diagnostic dot file. More...
subroutine, public	signal_dot_parse_chord (signal_dot_file_ref, coordinate_type, chord_name, xcart_i, xcart_f)
	Parse a chord from a diagnostic dot file. More...
real(rprec) function, public	signal_dot_parse_real (signal_dot_file_ref, message)
	Parse a single real from a diagnostic dot file. More...
real(rprec) function, dimension(2)	signal_dot_parse_2_real (signal_dot_file_ref, message)
	Parse a two reals from a diagnostic dot file. More...
real(rprec) function, dimension(3)	signal_dot_parse_3_real (signal_dot_file_ref, message)
	Parse a three reals from a diagnostic dot file. More...
integer function	signal_dot_parse_int (signal_dot_file_ref, message)
	Parse a single integer from a diagnostic dot file. More...
integer function, dimension(2)	signal_dot_parse_2_int (signal_dot_file_ref, message)
	Parse two integers from a diagnostic dot file. More...
character(len=data_name_length) function, public	signal_dot_read_keyword (signal_dot_file_ref, keywords)
	Read a keyword from the diagnostic dot file. More...
character(len=signal_dot_line_len) function, public	signal_dot_read_line (signal_dot_file_ref, pre_message, post_message)
	Read line from diagnostic dot file. More...

Variables
integer, parameter	signal_dot_line_len = 200
	Maximum line length.

Detailed Description

Defines the base class of type signal_dot_file. This module contains common code used in parsing diagnostic dot files. The actual parsing of the diagnostic dot file is handled by ipch_dot, thscte_dot and sxrch_dot.

Function/Subroutine Documentation

signal_dot_close()

subroutine, public signal_dot::signal_dot_close

(

type(signal_dot_file), intent(in)

signal_dot_file_ref

)

Close a diagnostic dot file.

Closes a diagnostic dot file.

Parameters

[in]

signal_dot_file_ref

An instance of a signal_dot_file object.

signal_dot_open()

type(signal_dot_file) function, public signal_dot::signal_dot_open	(	character (len=*), intent(in)	file,
		character (len=*), intent(in)	signal_id
	)

Open a diagnostic dot file.

Opens a diagnostic dot file for reading.

Parameters

[in]	file	Filename of the diagnostic dot file.
[in]	signal_id	Description of the diagnostic dot file.

Returns

A constructed signal_dot_file instance.

signal_dot_parse_2_int()

integer function, dimension(2) signal_dot::signal_dot_parse_2_int	(	type (signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	message
	)

Parse two integers from a diagnostic dot file.

Reads two integers from the diagnostic dot file. This is used to be able to get extra information about a diagnostic in the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	message	Error message to report back if there was a problem.

Returns

The parsed real value.

signal_dot_parse_2_real()

real (rprec) function, dimension(2) signal_dot::signal_dot_parse_2_real	(	type (signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	message
	)

Parse a two reals from a diagnostic dot file.

Reads three reals from the diagnostic dot file. This is used to be able to get extra information about a diagnostic in the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	message	Error message to report back if there was a problem.

Returns

The parsed real values.

signal_dot_parse_3_real()

real (rprec) function, dimension(3) signal_dot::signal_dot_parse_3_real	(	type (signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	message
	)

Parse a three reals from a diagnostic dot file.

Reads three reals from the diagnostic dot file. This is used to be able to get extra information about a diagnostic in the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	message	Error message to report back if there was a problem.

Returns

The parsed real values.

signal_dot_parse_chord()

subroutine, public signal_dot::signal_dot_parse_chord	(	type(signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	coordinate_type,
		character (len=data_short_name_length), intent(out)	chord_name,
		real(rprec), dimension(3), intent(out)	xcart_i,
		real(rprec), dimension(3), intent(out), optional	xcart_f
	)

Parse a chord from a diagnostic dot file.

Chords start with the first line as the chord name. The it is followed by one or two lines of 3 coordinates. All coodinates for the cord are returned in carteasian coordinates.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	coordinate_type	Specifies if the coordinate is cartesian or cylindrical.
[out]	chord_name	The name of the chord.
[out]	xcart_i	The initial position of the chord in cartesian coordinates.
[out]	xcart_f	The final position of the chord in cartesian coordinates.

signal_dot_parse_int()

integer function signal_dot::signal_dot_parse_int	(	type (signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	message
	)

Parse a single integer from a diagnostic dot file.

Reads a single integer from the diagnostic dot file. This is used to be able to get extra information about a diagnostic in the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	message	Error message to report back if there was a problem.

Returns

The parsed integer value.

signal_dot_parse_real()

real (rprec) function, public signal_dot::signal_dot_parse_real	(	type (signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	message
	)

Parse a single real from a diagnostic dot file.

Reads a single real from the diagnostic dot file. This is used to be able to get extra information about a diagnostic in the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	message	Error message to report back if there was a problem.

Returns

The parsed real value.

signal_dot_read_keyword()

character (len=data_name_length) function, public signal_dot::signal_dot_read_keyword	(	type(signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), dimension(:), intent(in)	keywords
	)

Read a keyword from the diagnostic dot file.

Read lines until a valid keyword is reached ot the end of the file is reached.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	keywords	List of keywords to search for.

Returns

The found keyword.

signal_dot_read_line()

character (len=signal_dot_line_len) function, public signal_dot::signal_dot_read_line	(	type(signal_dot_file), intent(inout)	signal_dot_file_ref,
		character (len=*), intent(in)	pre_message,
		character (len=*), intent(in)	post_message
	)

Read line from diagnostic dot file.

Reads single line from the diagnostic dot file.

Parameters

[in,out]	signal_dot_file_ref	An instance of a signal_dot_file object.
[in]	pre_message	Prefix message incase of error.
[in]	post_message	Post message incase of error.

Returns

The line that was read.