dm_request – DMPACK

The observation request data derived type declaration.

Uses

- dm_util
- dm_error
- dm_kind
- dm_time
- dm_id
- dm_response
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	public,	parameter	::	REQUEST_NAME_LEN	=	32	Request name length.
integer,	public,	parameter	::	REQUEST_REQUEST_LEN	=	256	Raw request string length.
integer,	public,	parameter	::	REQUEST_RESPONSE_LEN	=	256	Raw response string length.
integer,	public,	parameter	::	REQUEST_DELIMITER_LEN	=	8	Delimiter string length.
integer,	public,	parameter	::	REQUEST_PATTERN_LEN	=	256	Regular expression string length.
integer,	public,	parameter	::	REQUEST_MAX_NRESPONSES	=	16	Response array size.
integer,	public,	parameter	::	REQUEST_MODE_NONE	=	0	Default mode.
integer,	public,	parameter	::	REQUEST_MODE_GEOCOM_FILE	=	512	GeoCOM file download mode.
integer,	public,	parameter	::	REQUEST_STATE_NONE	=	0	Default state.
integer,	public,	parameter	::	REQUEST_STATE_DISABLED	=	1	Disabled state.
integer,	public,	parameter	::	REQUEST_SIZE	=	storage_size(request_type())/8	Size of `request_type` in bytes.

Interfaces

public interface operator (==)

Returns whether requests are equal.

public pure elemental function dm_request_equals(request1, request2) result(equals)

Returns .true. if given requests are equal.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(in)			::	request1	The first request.
type(request_type),	intent(in)			::	request2	The second request.

Return Value logical

public interface dm_request_get

Generic function to get value, unit, type, and error of a response.

private pure elemental subroutine request_get_byte(request, name, value, unit, type, error, status, default)

Returns byte response as single character value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type byte.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
character(len=1),	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
character(len=1),	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_int32(request, name, value, unit, type, error, status, default)

Returns 4-byte integer response value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type int32.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
integer(kind=i4),	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
integer(kind=i4),	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_int64(request, name, value, unit, type, error, status, default)

Returns 8-byte integer response value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type int64.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
integer(kind=i8),	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
integer(kind=i8),	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_logical(request, name, value, unit, type, error, status, default)

Returns logical response value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type logical.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
logical,	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
logical,	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_real32(request, name, value, unit, type, error, status, default)

Returns 4-byte real response value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type real32.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
real(kind=r4),	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
real(kind=r4),	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_real64(request, name, value, unit, type, error, status, default)

Returns 8-byte real response value, unit, type, and error of response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.
E_TYPE if the response value is not of type real64.

On error, value will not be modified, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
real(kind=r8),	intent(inout)		::	value	Response value.
character(len=RESPONSE_UNIT_LEN),	intent(out),	optional	::	unit	Response unit.
integer,	intent(out),	optional	::	type	Response value type.
integer,	intent(out),	optional	::	error	Response error.
integer,	intent(out),	optional	::	status	Error code.
real(kind=r8),	intent(in),	optional	::	default	Default value.

private pure elemental subroutine request_get_type(request, name, response, status, default)

Returns response of name name.

The routine returns the following error codes in status:

E_EMPTY if the request has no responses.
E_NOT_FOUND if a response of the given name does not exist.

On error, an empty response will be returned, unless default is passed.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in)		::	name	Response name.
type(response_type),	intent(out)		::	response	Response type.
integer,	intent(out),	optional	::	status	Error code.
type(response_type),	intent(in),	optional	::	default	Default response.

Derived Types

type, public :: request_type

Request to send to a sensor.

Components

Type	Visibility		Name		Initial
character(len=REQUEST_NAME_LEN),	public	::	name	=	' '	Request name (`-0-9A-Z_a-z`).
character(len=TIME_LEN),	public	::	timestamp	=	' '	ISO 8601 time stamp.
character(len=REQUEST_REQUEST_LEN),	public	::	request	=	' '	Raw request command (printable).
character(len=REQUEST_RESPONSE_LEN),	public	::	response	=	' '	Raw response (printable).
character(len=REQUEST_DELIMITER_LEN),	public	::	delimiter	=	' '	Response delimiter (printable).
character(len=REQUEST_PATTERN_LEN),	public	::	pattern	=	' '	Regular expression pattern.
integer,	public	::	delay	=	0	Delay in [msec] (optional).
integer,	public	::	error	=	E_NONE	Error code.
integer,	public	::	mode	=	REQUEST_MODE_NONE	Request mode (optional).
integer,	public	::	retries	=	0	Number of executed retries.
integer,	public	::	state	=	REQUEST_STATE_NONE	Request state (optional).
integer,	public	::	timeout	=	0	Timeout in [msec] (optional).
integer,	public	::	nresponses	=	0	Number of responses.
type(response_type),	public	::	responses(REQUEST_MAX_NRESPONSES)	=	response_type()	Responses array.

Functions

public function dm_request_add(request, response) result(rc)

Validates and appends response to the given request.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
type(response_type),	intent(inout)			::	response	Response to add.

Return Value integer

public pure elemental function dm_request_equals(request1, request2) result(equals)

Returns .true. if given requests are equal.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(in)			::	request1	The first request.
type(request_type),	intent(in)			::	request2	The second request.

Return Value logical

public pure elemental function dm_request_has_pattern(request) result(has)

Returns .true. if attribute pattern of request is not empty.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(in)			::	request	Request type.

Return Value logical

public pure elemental function dm_request_index(request, name) result(index)

Searches request for responses of passed name and returns the index of the first found. If no response of this name is found, the index is set to 0.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(in)			::	request	Request type.
character(len=*),	intent(in)			::	name	Response name.

Return Value integer

public pure elemental function dm_request_is_valid(request, timestamp) result(is)

Returns .true. if given observation request is valid. A request is valid if it conforms to the following requirements:

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(in)			::	request	Request type.
logical,	intent(in),	optional		::	timestamp	Validate or ignore timestamp.

Return Value logical

Subroutines

public pure elemental subroutine dm_request_set(request, name, timestamp, raw_request, raw_response, delimiter, pattern, delay, error, mode, retries, state, timeout, nresponses)

Sets request attributes, except responses.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
character(len=*),	intent(in),	optional	::	name	Request name.
character(len=*),	intent(in),	optional	::	timestamp	ISO 8601 time stamp.
character(len=*),	intent(in),	optional	::	raw_request	Raw request command.
character(len=*),	intent(in),	optional	::	raw_response	Raw response.
character(len=*),	intent(in),	optional	::	delimiter	Response delimiter.
character(len=*),	intent(in),	optional	::	pattern	Regular expression pattern.
integer,	intent(in),	optional	::	delay	Delay in [msec].
integer,	intent(in),	optional	::	error	Error code.
integer,	intent(in),	optional	::	mode	Request mode.
integer,	intent(in),	optional	::	retries	Number of executed retries.
integer,	intent(in),	optional	::	state	Request state.
integer,	intent(in),	optional	::	timeout	Timeout in [msec].
integer,	intent(in),	optional	::	nresponses	Number of responses.

public pure elemental subroutine dm_request_set_response_error(request, error, name)

Sets error code of all responses of the given request. If argument name is given, the error is set only for the first response of the same name.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(inout)		::	request	Request type.
integer,	intent(in)		::	error	Error code.
character(len=*),	intent(in),	optional	::	name	Response name.

public subroutine dm_request_out(request, unit)

Prints request to standard output or given file unit.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
integer,	intent(in),	optional		::	unit	File unit.

dm_request Module

Contents

Variables

Interfaces

Derived Types

Functions

Subroutines

Uses

Used by

Variables

Interfaces

public interface operator (==)

public pure elemental function dm_request_equals(request1, request2) result(equals)

Arguments

Return Value logical

public interface dm_request_get

private pure elemental subroutine request_get_byte(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_int32(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_int64(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_logical(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_real32(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_real64(request, name, value, unit, type, error, status, default)

Arguments

private pure elemental subroutine request_get_type(request, name, response, status, default)

Arguments

Derived Types

type, public :: request_type

Components

Functions

public function dm_request_add(request, response) result(rc)

Arguments

Return Value integer

public pure elemental function dm_request_equals(request1, request2) result(equals)

Arguments

Return Value logical

public pure elemental function dm_request_has_pattern(request) result(has)

Arguments

Return Value logical

public pure elemental function dm_request_index(request, name) result(index)

Arguments

Return Value integer

public pure elemental function dm_request_is_valid(request, timestamp) result(is)

Arguments

Return Value logical

Subroutines

public pure elemental subroutine dm_request_set(request, name, timestamp, raw_request, raw_response, delimiter, pattern, delay, error, mode, retries, state, timeout, nresponses)

Arguments

public pure elemental subroutine dm_request_set_response_error(request, error, name)

Arguments

public subroutine dm_request_out(request, unit)

Arguments