dm_request_add Interface

public interface dm_request_add

Generic function to add response.

Called by

Help

Module Procedures

private function request_add_int32(request, name, unit, value, error) result(rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
character(len=*),	intent(in)			::	name	Response name.
character(len=*),	intent(in)			::	unit	Response unit.
integer(kind=i4),	intent(in)			::	value	Response value.
integer,	intent(in),	optional		::	error	Response error.

Return Value integer

private function request_add_int64(request, name, unit, value, error) result(rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
character(len=*),	intent(in)			::	name	Response name.
character(len=*),	intent(in)			::	unit	Response unit.
integer(kind=i8),	intent(in)			::	value	Response value.
integer,	intent(in),	optional		::	error	Response error.

Return Value integer

private function request_add_real32(request, name, unit, value, error) result(rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
character(len=*),	intent(in)			::	name	Response name.
character(len=*),	intent(in)			::	unit	Response unit.
real(kind=r4),	intent(in)			::	value	Response value.
integer,	intent(in),	optional		::	error	Response error.

Return Value integer

private function request_add_real64(request, name, unit, value, error) result(rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(inout)			::	request	Request type.
character(len=*),	intent(in)			::	name	Response name.
character(len=*),	intent(in)			::	unit	Response unit.
real(kind=r8),	intent(in)			::	value	Response value.
integer,	intent(in),	optional		::	error	Response error.

Return Value integer

private function request_add_type(request, response) result(rc)

Validates and appends response to the given request.

The function returns the following error codes:

E_BOUNDS if the responses array is full.
E_INVALID if the response is invalid.

The request attribute nresponses must be between 0 and one less than REQUEST_MAX_NRESPONSES for the response to be added.

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