dm_geocom_api – DMPACK

Procedures for GeoCOM protocol handling. The routines in this module only prepare requests and responses for GeoCOM API calls.

The GeoCOM API is divided into the following sub-systems:

AUT – Automation
BAP – Basic Applications
BMM – Basic Man-Machine Interface
COM – Communication Settings
CSV – Central Services
EDM – Electronic Distance Measurement
FTR – File Transfer
IMG – Image Processing
MOT – Motorisation
SUP – Supervisor
TMC – Theodolite Measurement and Calculation

API

GeoCOM API	DMPACK API
`AUS_GetUserAtrState`	`dm_geocom_api_request_get_user_atr_mode`
`AUS_GetUserLockState`	`dm_geocom_api_request_get_user_lock_mode`
`AUS_SetUserAtrState`	`dm_geocom_api_request_set_user_atr_mode`
`AUS_SetUserLockState`	`dm_geocom_api_request_set_user_lock_mode`
`AUT_ChangeFace`	`dm_geocom_api_request_change_face`
`AUT_FineAdjust`	`dm_geocom_api_request_fine_adjust`
`AUT_GetFineAdjustMode`	`dm_geocom_api_request_get_fine_adjust_mode`
`AUT_GetSearchArea`	`dm_geocom_api_request_get_search_area`
`AUT_GetUserSpiral`	`dm_geocom_api_request_get_user_spiral`
`AUT_LockIn`	`dm_geocom_api_request_lock_in`
`AUT_MakePositioning`	`dm_geocom_api_request_set_position`
`AUT_PS_EnableRange`	`dm_geocom_api_request_ps_enable_range`
`AUT_PS_SearchNext`	`dm_geocom_api_request_ps_search_next`
`AUT_PS_SearchWindow`	`dm_geocom_api_request_ps_search_window`
`AUT_PS_SetRange`	`dm_geocom_api_request_ps_set_range`
`AUT_ReadTimeout`	`dm_geocom_api_request_get_timeout`
`AUT_ReadTol`	`dm_geocom_api_request_get_tolerance`
`AUT_Search`	`dm_geocom_api_request_get_search`
`AUT_SetFineAdjustMode`	`dm_geocom_api_request_set_fine_adjust_mode`
`AUT_SetSearchArea`	`dm_geocom_api_request_set_search_area`
`AUT_SetTimeout`	`dm_geocom_api_request_set_positioning_timeout`
`AUT_SetTol`	`dm_geocom_api_request_set_tolerance`
`AUT_SetUserSpiral`	`dm_geocom_api_request_set_user_spiral`
`BAP_GetATRSetting`	`dm_geocom_api_request_get_atr_setting`
`BAP_GetMeasPrg`	`dm_geocom_api_request_get_measurement_program`
`BAP_GetPrismDef`	`dm_geocom_api_request_get_prism_definition`
`BAP_GetRedATRFov`	`dm_geocom_api_request_get_reduced_atr_fov`
`BAP_GetTargetType`	`dm_geocom_api_request_get_target_type`
`BAP_GetUserPrismDef`	`dm_geocom_api_request_get_user_prism_definition`
`BAP_MeasDistanceAngle`	`dm_geocom_api_request_measure_distance_angle`
`BAP_SearchTarget`	`dm_geocom_api_request_search_target`
`BAP_SetATRSetting`	`dm_geocom_api_request_set_atr_mode`
`BAP_SetAtmCorr`	`dm_geocom_api_request_set_atmospheric_correction`
`BAP_SetAtmPpm`	`dm_geocom_api_request_set_atmospheric_ppm`
`BAP_SetMeasPrg`	`dm_geocom_api_request_set_measurement_program`
`BAP_SetPrismType2`	`dm_geocom_api_request_set_prism_type_v2`
`BAP_SetPrismType`	`dm_geocom_api_request_set_prism_type`
`BAP_SetRedATRFov`	`dm_geocom_api_request_set_reduced_atr_fov`
`BAP_SetTargetType`	`dm_geocom_api_request_set_target_type`
`BAP_SetUserPrismDef`	`dm_geocom_api_request_set_user_prism_definition`
`BMM_BeepAlarm`	`dm_geocom_api_request_beep_alarm`
`BMM_BeepNormal`	`dm_geocom_api_request_beep_normal`
`COM_GetBinaryAvailable`	`dm_geocom_api_request_get_binary_mode`
`COM_GetDoublePrecision`	`dm_geocom_api_request_get_double_precision`
`COM_GetSWVersion`	`dm_geocom_api_request_get_geocom_version`
`COM_NullProc`	`dm_geocom_api_request_null`
`COM_SetBinaryAvailable`	`dm_geocom_api_request_set_binary_mode`
`COM_SetDoublePrecision`	`dm_geocom_api_request_set_double_precision`
`COM_SwitchOffTPS`	`dm_geocom_api_request_switch_off`
`COM_SwitchOffTPS`	`dm_geocom_api_request_switch_on`
`CSV_CheckPower`	`dm_geocom_api_request_get_power`
`CSV_GetDateTimeCentiSec`	`dm_geocom_api_request_get_date_time_centi`
`CSV_GetDateTime`	`dm_geocom_api_request_get_date_time`
`CSV_GetDeviceConfig`	`dm_geocom_api_request_get_device_config`
`CSV_GetInstrumentName`	`dm_geocom_api_request_get_instrument_name`
`CSV_GetInstrumentNo`	`dm_geocom_api_request_get_instrument_number`
`CSV_GetIntTemp`	`dm_geocom_api_request_get_internal_temperature`
`CSV_GetReflectorlessClass`	`dm_geocom_api_request_get_reflectorless_class`
`CSV_GetSWVersion`	`dm_geocom_api_request_get_software_version`
`CSV_SetDateTime`	`dm_geocom_api_request_set_date_time`
`EDM_GetEglIntensity`	`dm_geocom_api_request_get_egl_intensity`
`EDM_Laserpointer`	`dm_geocom_api_request_set_laser_pointer`
`EDM_SetEglIntensity`	`dm_geocom_api_request_set_egl_intensity`
`FTR_AbortDownload`	`dm_geocom_api_request_abort_download`
`FTR_AbortList`	`dm_geocom_api_request_abort_list`
`FTR_Delete`	`dm_geocom_api_request_delete`
`FTR_Download`	`dm_geocom_api_request_download`
`FTR_List`	`dm_geocom_api_request_list`
`FTR_SetupDownload`	`dm_geocom_api_request_setup_download`
`FTR_SetupList`	`dm_geocom_api_request_setup_list`
`IMG_GetTccConfig`	`dm_geocom_api_request_get_image_config`
`IMG_SetTccConfig`	`dm_geocom_api_request_set_image_config`
`IMG_TakeTccImage`	`dm_geocom_api_request_take_image`
`IOS_BeepOff`	`dm_geocom_api_request_beep_off`
`IOS_BeepOn`	`dm_geocom_api_request_beep_on`
`MOT_ReadLockStatus`	`dm_geocom_api_request_get_lock_status`
`MOT_SetVelocity`	`dm_geocom_api_request_set_velocity`
`MOT_StartController`	`dm_geocom_api_request_start_controller`
`MOT_StopController`	`dm_geocom_api_request_stop_controller`
`SUP_GetConfig`	`dm_geocom_api_request_get_config`
`SUP_SetConfig`	`dm_geocom_api_request_set_config`
`TMC_DoMeasure`	`dm_geocom_api_request_do_measure`
`TMC_GeoPpm`	`dm_geocom_api_request_get_geometric_ppm`
`TMC_GetAngSwitch`	`dm_geocom_api_request_get_angle_correction`
`TMC_GetAngle1`	`dm_geocom_api_request_get_angle_complete`
`TMC_GetAngle5`	`dm_geocom_api_request_get_angle`
`TMC_GetAtmCorr`	`dm_geocom_api_request_get_atmospheric_correction`
`TMC_GetAtmPpm`	`dm_geocom_api_request_get_atmospheric_ppm`
`TMC_GetCoordinate`	`dm_geocom_api_request_get_coordinate`
`TMC_GetEdmMode`	`dm_geocom_api_request_get_edm_mode`
`TMC_GetFace`	`dm_geocom_api_request_get_face`
`TMC_GetFullMeas`	`dm_geocom_api_request_get_full_measurement`
`TMC_GetHeight`	`dm_geocom_api_request_get_height`
`TMC_GetInclineSwitch`	`dm_geocom_api_request_get_inclination_correction`
`TMC_GetPrismCorr`	`dm_geocom_api_request_get_prism_constant`
`TMC_GetPrismType2`	`dm_geocom_api_request_get_prism_type_v2`
`TMC_GetPrismType`	`dm_geocom_api_request_get_prism_type`
`TMC_GetQuickDist`	`dm_geocom_api_request_get_quick_distance`
`TMC_GetRefractiveMethod`	`dm_geocom_api_request_get_refraction_mode`
`TMC_GetSignal`	`dm_geocom_api_request_get_signal`
`TMC_GetSimpleCoord`	`dm_geocom_api_request_get_simple_coordinates`
`TMC_GetSimpleMea`	`dm_geocom_api_request_get_simple_measurement`
`TMC_GetSlopeDistCorr`	`dm_geocom_api_request_get_slope_distance_correction`
`TMC_GetStation`	`dm_geocom_api_request_get_station`
`TMC_IfDataAzeCorrError`	`dm_geocom_api_request_get_atr_error`
`TMC_IfDataIncCorrError`	`dm_geocom_api_request_get_inclination_error`
`TMC_QuickDist`	`dm_geocom_api_request_get_quick_distance`
`TMC_SetAngSwitch`	`dm_geocom_api_request_set_angle_correction`
`TMC_SetEdmMode`	`dm_geocom_api_request_set_edm_mode`
`TMC_SetGeoPpm`	`dm_geocom_api_request_set_geometric_ppm`
`TMC_SetHandDist`	`dm_geocom_api_request_set_distance`
`TMC_SetHeight`	`dm_geocom_api_request_set_height`
`TMC_SetInclineSwitch`	`dm_geocom_api_request_set_inclination_correction`
`TMC_SetOrientation`	`dm_geocom_api_request_set_orientation`
`TMC_SetPrismCorr`	`dm_geocom_api_request_set_prism_constant`
`TMC_SetRefractiveMethod`	`dm_geocom_api_request_set_refraction_mode`
`TMC_SetStation`	`dm_geocom_api_request_set_station`

Uses

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.

Used by

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.

Subroutines

public pure subroutine dm_geocom_api_request(request, name, code, arguments, pattern, responses, mode)

Prepares a DMPACK request type by setting request command, response pattern, response delimiter, and response definition array.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(out)		::	request	Prepared request type.
character(len=*),	intent(in)		::	name	Request name.
integer,	intent(in)		::	code	GeoCOM request code.
character(len=*),	intent(in),	optional	::	arguments	GeoCOM request arguments.
character(len=*),	intent(in),	optional	::	pattern	Regular expression pattern that matches the raw response.
type(response_type),	intent(in),	optional	::	responses(:)	Array of response types.
integer,	intent(in),	optional	::	mode	Mode of returned observation request (`REQUEST_MODE_*`).

public pure subroutine dm_geocom_api_request_abort_download(request)

Request of FTR_AbortDownload procedure. Creates request to abort or end the file download command.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_abort_list(request)

Request of FTR_AbortList procedure. Creates request to abort or end the file list command.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_beep_alarm(request)

Request of BMM_BeepAlarm procedure. Creates request to output an alarm signal (triple beep).

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_beep_normal(request)

Request of BMM_BeepNormal procedure. Creates request to output an alarm signal (single beep).

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_beep_off(request)

Request of IOS_BeepOff procedure. Creates request to stop an active beep signal.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_beep_on(request, intensity)

Request of IOS_BeepOn procedure. Creates request for continuous beep signal of given intensity.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	intensity	Intensity of beep, from 0 to 100.

public pure subroutine dm_geocom_api_request_change_face(request, pos_mode, atr_mode)

Request of AUT_ChangeFace procedure. Creates request for turning the telescope to the other face.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	pos_mode	Position mode (`GEOCOM_AUT_POSMODE`).
integer,	intent(in)	::	atr_mode	ATR mode (`GEOCOM_AUT_ATRMODE`).

public pure subroutine dm_geocom_api_request_delete(request, device_type, file_type, day, month, year, file_name)

Request of FTR_Delete procedure. Creates request for deleting one or more files.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	device_type	Internal memory or memory card (`GEOCOM_FTR_DEVICETYPE`).
integer,	intent(in)	::	file_type	Type of file (`GEOCOM_FTR_FILETYPE`).
integer,	intent(in)	::	day	Day (`DD`).
integer,	intent(in)	::	month	Month (`MM`).
integer,	intent(in)	::	year	Year (`YY`).
character(len=*),	intent(in)	::	file_name	Name of file to delete.

public pure subroutine dm_geocom_api_request_do_measure(request, tmc_prog, inc_mode)

Request of TMC_DoMeasure procedure. Creates request for trying a distance measurement. This command does not return any values.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	tmc_prog	TMC measurement program (`GEOCOM_TMC_MEASURE_PRG`).
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_download(request, block_number)

Request of FTR_Download procedure. Creates request to get a single block of data. The FTR_SetupDownload command has to be called first.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	block_number	Block number.

public pure subroutine dm_geocom_api_request_fine_adjust(request, search_hz, search_v)

Request of AUT_FineAdjust procedure. Creates request for automatic target positioning.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	search_hz	Search range, Hz axis [rad].
real(kind=r8),	intent(in)	::	search_v	Search range, V axis [rad].

public pure subroutine dm_geocom_api_request_get_angle(request, inc_mode)

Request of TMC_GetAngle5 procedure. Creates request for returning a simple angle measurement.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_angle_complete(request, inc_mode)

Request of TMC_GetAngle1 procedure. Creates request for returning a complete angle measurement.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_angle_correction(request)

Request of TMC_GetAngSwitch procedure. Creates request for getting the angular correction status.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_atmospheric_correction(request)

Request of TMC_GetAtmCorr procedure. Creates request for getting the atmospheric correction parameters.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_atmospheric_ppm(request)

Request of TMC_GetAtmPpm procedure. Creates request for getting the atmospheric ppm correction factor.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_atr_error(request)

Request of TMC_IfDataAzeCorrError procedure. Creates request for getting the ATR error status.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_atr_setting(request)

Request of BAP_GetATRSetting procedure. Creates request for getting the current ATR Low-Vis mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_binary_mode(request)

Request of COM_GetBinaryAvailable procedure. Creates request for getting the binary attribute of the server.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_config(request)

Request of SUP_GetConfig procedure. Creates request for getting the power management configuration status. The power timeout specifies the time after which the device switches into the mode indicated by autopwr.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_coordinate(request, wait_time, inc_mode)

Request of TMC_GetCoordinate procedure. Creates request for getting the coordinates of a measured point.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	wait_time	Delay to wait for the distance measurement to finish [msec].
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_date_time(request)

Request of CSV_GetDateTime procedure. Creates request for getting the current date and time of the instrument. A possible response may look like %R1P,0,0:0,1996,'07','19','10','13','2f'.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_date_time_centi(request)

Request of CSV_GetDateTimeCentiSec procedure. Creates request for getting the current date and time of the instrument, including centiseconds.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_device_config(request)

Request of CSV_GetDeviceConfig procedure. Creates request for getting the instrument configuration.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_double_precision(request)

Request of COM_GetDoublePrecision procedure. Creates request for getting the double precision setting – the number of digits to the right of the decimal point – when double floating-point values are transmitted.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_edm_mode(request)

Request of TMC_GetEdmMode procedure. Creates request for getting the EDM measurement mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_egl_intensity(request)

Request of EDM_GetEglIntensity procedure. Creates request for getting the value of the intensity of the electronic guide light (EGL).

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_face(request)

Request of TMC_GetFace procedure. Creates request for getting the face of the current telescope position.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_fine_adjust_mode(request)

Request of AUT_GetFineAdjustMode procedure. Creates request for getting the fine adjustment positioning mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_full_measurement(request, wait_time, inc_mode)

Request of TMC_GetFullMeas procedure. Creates request to query angle, inclination, and distance measurement values.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	wait_time	Delay to wait for the distance measurement to finish [msec].
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_geocom_version(request)

Request of COM_GetSWVersion procedure. Creates request for getting the GeoCOM server software version.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_geometric_ppm(request)

Request of TMC_GeoPpm procedure. Creates request for getting the geometric ppm correction factor.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_height(request)

Request of TMC_GetHeight procedure. Creates request for getting the current reflector height.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_image_config(request, mem_type)

Request of IMG_GetTccConfig procedure. Creates request to read the current image configuration. The response subfunc is a binary combination of the following settings:

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	mem_type	Memory device type (`GEOCOM_IMG_MEM_TYPE`).

public pure subroutine dm_geocom_api_request_get_inclination_correction(request)

Request of TMC_GetInclineSwitch procedure. Creates request for getting the dual-axis compensator status.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_inclination_error(request)

Request of TMC_IfDataIncCorrError procedure. Creates request for getting the inclination error status.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_instrument_name(request)

Request of CSV_GetInstrumentName procedure. Creates request for getting the Leica-specific instrument name.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_instrument_number(request)

Request of CSV_GetInstrumentNo procedure. Creates request for getting the factory defined instrument number.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_internal_temperature(request)

Request of CSV_GetIntTemp procedure. Creates request for getting the internal temperature of the instrument, measured on the mainboard side.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_lock_status(request)

Request of MOT_ReadLockStatus procedure. Creates request for returning the condition of the Lock-In control.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_measurement_program(request)

Request of BAP_GetMeasPrg procedure. Creates request for getting the distance measurement program of the instrument.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_power(request)

Request of CSV_CheckPower procedure. Creates request for checking the available power.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_prism_constant(request)

Request of TMC_GetPrismCorr procedure. Creates request for getting the prism constant.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_prism_definition(request, prism_type)

Request of BAP_GetPrismDef procedure. Creates request for getting the default prism definition.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	prism_type	Prism type (`GEOCOM_BAP_PRISMTYPE`).

public pure subroutine dm_geocom_api_request_get_prism_type(request)

Request of TMC_GetPrismType procedure. Creates request for getting the default prism type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_prism_type_v2(request)

Request of TMC_GetPrismType2 procedure. Creates request for getting the default or user prism type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_quick_distance(request)

Request of TMC_QuickDist procedure. Creates request for returning the slope distance and both angles.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_reduced_atr_fov(request)

Request of BAP_GetRedATRFov procedure. Creates request for getting the reduced ATR field of view.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_reflectorless_class(request)

Request of CSV_GetReflectorlessClass procedure. Creates request for getting the RL type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_refraction_mode(request)

Request of TMC_GetRefractiveMethod procedure. Creates request for getting the refraction model.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_search_area(request)

Request of AUT_GetSearchArea procedure. Creates request for getting the dimensions of the PowerSearch window.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_signal(request)

Request of TMC_GetSignal procedure. Creates request for getting the EDM signal intensity.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_simple_coordinates(request, wait_time, inc_mode)

Request of TMC_GetSimpleCoord procedure. Creates request for returning cartesian coordinates.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	wait_time	Delay to wait for the distance measurement to finish [msec].
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_simple_measurement(request, wait_time, inc_mode)

Request of TMC_GetSimpleMea procedure. Creates request for returning the values of the angle and distance measurement.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	wait_time	Delay to wait for the distance measurement to finish [msec].
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_get_slope_distance_correction(request)

Request of TMC_GetSlopeDistCorr procedure. Creates request for getting the total ppm and prism correction.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_software_version(request)

Request of CSV_GetSWVersion procedure. Creates request for getting the system software version of the instrument.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_station(request)

Request of TMC_GetStation procedure. Creates request for getting the station coordinates of the instrument.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_target_type(request)

Request of BAP_GetTargetType procedure. Creates request for getting the EDM type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_timeout(request)

Request of AUT_ReadTimeout procedure. Creates request for getting the timeout for positioning.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_tolerance(request)

Request of AUT_ReadTol procedure. Creates request for getting the positioning tolerances.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_user_atr_mode(request)

Request of AUS_GetUserAtrState procedure. Creates request for getting the status of the ATR mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_user_lock_mode(request)

Request of AUS_GetUserLockState procedure. Creates request for getting the status of the Lock mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_get_user_prism_definition(request, name)

Request of BAP_GetUserPrismDef procedure. Creates request for getting the user prism definition.

Arguments

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

public pure subroutine dm_geocom_api_request_get_user_spiral(request)

Request of AUT_GetUserSpiral procedure. Creates request for getting the user-defined search spiral.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_list(request, next)

Request of FTR_List procedure. Creates request for listing file information.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	next	First or next entry.

public pure subroutine dm_geocom_api_request_lock_in(request)

Request of AUT_LockIn procedure. Creates request for starting the target tracking.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_measure_distance_angle(request, dist_mode)

Request of BAP_MeasDistanceAngle procedure. Creates request for measuring Hz, V angles and a single distance.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	dist_mode	Distance measurement mode (`GEOCOM_BAP_MEASURE_PRG`).

public pure subroutine dm_geocom_api_request_null(request)

Request of COM_NullProc procedure. Creates request for checking the communication.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_ps_enable_range(request, enabled)

Request of AUT_PS_EnableRange procedure. Creates request for enabling the PowerSearch window and range.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable PowerSearch.

public pure subroutine dm_geocom_api_request_ps_search_next(request, direction, swing)

Request of AUT_PS_SearchNext procedure. Creates request for searching for the next target.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	direction	Searching direction (`1` for clockwise, `-1` for counter-clockwise).
logical,	intent(in)	::	swing	Searching starts –10 gon to the given direction.

public pure subroutine dm_geocom_api_request_ps_search_window(request)

Request of AUT_PS_SearchWindow procedure. Creates request for starting PowerSearch.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_ps_set_range(request, min_dist, max_dist)

Request of AUT_PS_SetRange procedure. Creates request for setting the PowerSearch range.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	min_dist	Min. distance to prism (≥ 0) [m].
integer,	intent(in)	::	max_dist	Max. distance to prism (≤ 400, ≥ `min_dist` + 10) [m].

public pure subroutine dm_geocom_api_request_search(request, search_hz, search_v)

Request of AUT_Search procedure. Creates request for performing an automatic target search.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	search_hz	Horizontal search region [rad].
real(kind=r8),	intent(in)	::	search_v	Vertical search region [rad].

public pure subroutine dm_geocom_api_request_search_target(request)

Request of BAP_SearchTarget procedure. Creates request for searching a target.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.

public pure subroutine dm_geocom_api_request_set_angle_correction(request, incline, stand_axis, collimation, tilt_axis)

Request of TMC_SetAngSwitch procedure. Creates request for turning angle corrections on or off.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
logical,	intent(in)	::	incline	Enable inclination correction.
logical,	intent(in)	::	stand_axis	Enable standard axis correction.
logical,	intent(in)	::	collimation	Enable collimation correction.
logical,	intent(in)	::	tilt_axis	Enable tilt axis correction.

public pure subroutine dm_geocom_api_request_set_atmospheric_correction(request, lambda, pressure, dry_temp, wet_temp)

Request of BAP_SetAtmCorr procedure. Creates request for setting the atmospheric correction parameters.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	lambda	Wave-length of EDM transmitter [m].
real(kind=r8),	intent(in)	::	pressure	Atmospheric pressure [mbar].
real(kind=r8),	intent(in)	::	dry_temp	Dry temperature [°C].
real(kind=r8),	intent(in)	::	wet_temp	Wet temperature [°C].

public pure subroutine dm_geocom_api_request_set_atmospheric_ppm(request, atm_ppm)

Request of BAP_SetAtmPpm procedure. Creates request for setting the atmospheric ppm correction factor.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
real(kind=r8),	intent(in)			::	atm_ppm	Atmospheric ppm correction factor [ppm].

public pure subroutine dm_geocom_api_request_set_atr_mode(request, atr_mode)

Request of BAP_SetATRSetting procedure. Creates request for setting the ATR low-vis mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	atr_mode	ATR low-vis mode (`GEOCOM_BAP_ATRSETTING`).

public pure subroutine dm_geocom_api_request_set_binary_mode(request, enabled)

Request of COM_SetBinaryAvailable procedure. Creates request for setting the binary attribute of the server.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable binary communication.

public pure subroutine dm_geocom_api_request_set_config(request, auto_power, timeout)

Request of SUP_SetConfig procedure. Creates request for setting the power management configuration.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	auto_power	Power-off mode (`GEOCOM_SUP_AUTO_POWER`).
integer,	intent(in)	::	timeout	Timeout [msec].

public pure subroutine dm_geocom_api_request_set_date_time(request, year, month, day, hour, minute, second)

Request of CSV_SetDateTime procedure. Creates request for setting the date and time of the instrument.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	year	Year (`YYYY`).
integer,	intent(in)	::	month	Month (`MM`).
integer,	intent(in)	::	day	Day of month (`DD`).
integer,	intent(in)	::	hour	Hour (`hh`).
integer,	intent(in)	::	minute	Minute (`mm`).
integer,	intent(in)	::	second	Second (`ss`).

public pure subroutine dm_geocom_api_request_set_distance(request, slope_dist, height_offset, inc_mode)

Request of TMC_SetHandDist procedure. Creates request for setting the slope distance and height offset.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	slope_dist	Slope distance [m].
real(kind=r8),	intent(in)	::	height_offset	Height offset [m].
integer,	intent(in)	::	inc_mode	Inclination measurement mode (`GEOCOM_TMC_INCLINE_PRG`).

public pure subroutine dm_geocom_api_request_set_double_precision(request, ndigits)

Request of COM_SetDoublePrecision procedure. Creates request for setting the double precision.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	ndigits	Number of digits right to the comma.

public pure subroutine dm_geocom_api_request_set_edm_mode(request, edm_mode)

Request of TMC_SetEdmMode procedure. Creates request for setting the EDM measurement mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	edm_mode	EDM measurement mode (`GEOCOM_EDM_MODE`).

public pure subroutine dm_geocom_api_request_set_egl_intensity(request, intensity)

Request of EDM_SetEglIntensity procedure. Creates request for setting the intensity of the electronic guide light.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	intensity	EGL intensity (`GEOCOM_EDM_EGLINTENSITY_TYPE`).

public pure subroutine dm_geocom_api_request_set_fine_adjust_mode(request, adj_mode)

Request of AUT_SetFineAdjustMode procedure. Creates request for setting the fine adjust positioning mode.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	adj_mode	Fine adjust positioning mode (`GEOCOM_AUT_ADJMODE`).

public pure subroutine dm_geocom_api_request_set_geometric_ppm(request, enabled, scale_factor, offset, height_ppm, individual_ppm)

Request of TMC_SetGeoPpm procedure. Creates request for setting the geometric ppm correction factor.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
logical,	intent(in)	::	enabled	Enable geometric ppm calculation.
real(kind=r8),	intent(in)	::	scale_factor	Scale factor on central meridian.
real(kind=r8),	intent(in)	::	offset	Offset from central meridian [m].
real(kind=r8),	intent(in)	::	height_ppm	Ppm value due to height above reference.
real(kind=r8),	intent(in)	::	individual_ppm	Individual ppm value.

public pure subroutine dm_geocom_api_request_set_height(request, height)

Request of TMC_SetHeight procedure. Creates request for setting a new reflector height.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
real(kind=r8),	intent(in)			::	height	Reflector height [m].

public pure subroutine dm_geocom_api_request_set_image_config(request, mem_type, image_number, quality, sub_function, prefix)

Request of IMG_SetTccConfig procedure. Creates request for setting the image configuration.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	mem_type	Memory device type (`GEOCOM_IMG_MEM_TYPE`).
integer,	intent(in)	::	image_number	Actual image number.
integer,	intent(in)	::	quality	JPEG compression factor (0 – 100).
integer,	intent(in)	::	sub_function	Additional sub-functions to call.
character(len=*),	intent(in)	::	prefix	File name prefix.

public pure subroutine dm_geocom_api_request_set_inclination_correction(request, enabled)

Request of TMC_SetInclineSwitch procedure. Creates request for turning the dual-axis compensator on or off.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable dual-axis compensator.

public pure subroutine dm_geocom_api_request_set_laser_pointer(request, enabled)

Request of EDM_Laserpointer procedure. Creates request for turning the laser pointer on or off.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable laser pointer.

public pure subroutine dm_geocom_api_request_set_measurement_program(request, bap_prog)

Request of BAP_SetMeasPrg procedure. Creates request for setting the distance measurement program.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	bap_prog	Measurement program (`GEOCOM_BAP_USER_MEASPRG`).

public pure subroutine dm_geocom_api_request_set_orientation(request, hz)

Request of TMC_SetOrientation procedure. Creates request for orientating the instrument in horizontal direction.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
real(kind=r8),	intent(in)			::	hz	Horizontal orientation [rad].

public pure subroutine dm_geocom_api_request_set_position(request, hz, v, pos_mode, atr_mode)

Request of AUT_MakePositioning procedure. Creates request for turning the telescope to a specified position.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	hz	Horizontal angle [rad].
real(kind=r8),	intent(in)	::	v	Vertical angle [rad].
integer,	intent(in)	::	pos_mode	Position mode (`GEOCOM_AUT_POSMODE`).
integer,	intent(in)	::	atr_mode	ATR mode (`GEOCOM_AUT_ATRMODE`).

public pure subroutine dm_geocom_api_request_set_positioning_timeout(request, time_hz, time_v)

Request of AUT_SetTimeout procedure. Creates request for setting the timeout for positioning.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	time_hz	Timeout in Hz direction [s].
real(kind=r8),	intent(in)	::	time_v	Timeout in V direction [s].

public pure subroutine dm_geocom_api_request_set_prism_constant(request, prism_const)

Request of TMC_SetPrismCorr procedure. Creates request for setting the prism constant. The API function BAP_SetPrismType overwrites this setting.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
real(kind=r8),	intent(in)			::	prism_const	Prism constant [mm].

public pure subroutine dm_geocom_api_request_set_prism_type(request, prism_type)

Request of BAP_SetPrismType procedure. Creates request for setting the default prism type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	prism_type	Prism type (`GEOCOM_BAP_PRISMTYPE`).

public pure subroutine dm_geocom_api_request_set_prism_type_v2(request, prism_type, prism_name)

Request of BAP_SetPrismType2 procedure. Creates request for setting the default or user prism type.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	prism_type	Prism type (`GEOCOM_BAP_PRISMTYPE`).
character(len=*),	intent(in)	::	prism_name	Prism name (required if prism type is `GEOCOM_BAP_PRISM_USER`).

public pure subroutine dm_geocom_api_request_set_reduced_atr_fov(request, enabled)

Request of BAP_SetRedATRFov procedure. Creates request for setting the reduced ATR field of view.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Use reduced field of view.

public pure subroutine dm_geocom_api_request_set_refraction_mode(request, mode)

Request of TMC_SetRefractiveMethod procedure. Creates request for setting the refraction model.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	mode	Refraction data method (1 or 2).

public pure subroutine dm_geocom_api_request_set_search_area(request, center_hz, center_v, range_hz, range_v, enabled)

Request of AUT_SetSearchArea procedure. Creates request for setting the PowerSearch window.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	center_hz	Search area center Hz angle [rad].
real(kind=r8),	intent(in)	::	center_v	Search area center V angle [rad].
real(kind=r8),	intent(in)	::	range_hz	Search area range Hz angle [rad].
real(kind=r8),	intent(in)	::	range_v	Search area range V angle [rad].
logical,	intent(in)	::	enabled	Enable search area.

public pure subroutine dm_geocom_api_request_set_station(request, easting, northing, height, instr_height)

Request of TMC_SetStation procedure. Creates request for setting the station coordinates of the instrument.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	easting	E coordinate [m].
real(kind=r8),	intent(in)	::	northing	N coordinate [m].
real(kind=r8),	intent(in)	::	height	H coordinate [m].
real(kind=r8),	intent(in)	::	instr_height	Instrument height [m].

public pure subroutine dm_geocom_api_request_set_target_type(request, target_type)

Request of BAP_SetTargetType procedure. Creates request for setting the EDM type.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	target_type	Target type (`GEOCOM_BAP_TARGET_TYPE`).

public pure subroutine dm_geocom_api_request_set_tolerance(request, hz, v)

Request of AUT_SetTol procedure. Creates request for setting the positioning tolerances.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	hz	Positioning tolerance in Hz direction [rad].
real(kind=r8),	intent(in)	::	v	Positioning tolerance in V direction [rad].

public pure subroutine dm_geocom_api_request_set_user_atr_mode(request, enabled)

Request of AUS_SetUserAtrState procedure. Creates request for setting the status of the ATR state.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable ATR mode.

public pure subroutine dm_geocom_api_request_set_user_lock_mode(request, enabled)

Request of AUS_SetUserLockState procedure. Creates request for setting the status of the Lock state.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
logical,	intent(in)			::	enabled	Enable Lock mode.

public pure subroutine dm_geocom_api_request_set_user_prism_definition(request, prism_name, prism_const, refl_type, creator)

Request of BAP_SetUserPrismDef procedure. Creates request for setting a user prism definition.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
character(len=*),	intent(in)	::	prism_name	Prism name.
real(kind=r8),	intent(in)	::	prism_const	Prism correction constant [mm].
integer,	intent(in)	::	refl_type	Reflector type (`GEOCOM_BAP_REFLTYPE`).
character(len=*),	intent(in)	::	creator	Name of creator.

public pure subroutine dm_geocom_api_request_set_user_spiral(request, hz, v)

Request of AUT_SetUserSpiral procedure. Creates request for setting the ATR search window.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	hz	ATR search window in Hz direction [rad].
real(kind=r8),	intent(in)	::	v	ATR search window in V direction [rad].

public pure subroutine dm_geocom_api_request_set_velocity(request, omega_hz, omega_v)

Request of MOT_SetVelocity procedure. Creates request for driving the instrument with constant speed.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
real(kind=r8),	intent(in)	::	omega_hz	Velocity in Hz direction [rad/s].
real(kind=r8),	intent(in)	::	omega_v	Velocity in V direction [rad/s].

public pure subroutine dm_geocom_api_request_setup_download(request, device_type, file_type, file_name, block_size)

Request of FTR_SetupDownload procedure. Creates request for setting up a file download.

Arguments

Type	Intent		Name
type(request_type),	intent(out)	::	request	Prepared request.
integer,	intent(in)	::	device_type	Device type (`GEOCOM_FTR_DEVICETYPE`).
integer,	intent(in)	::	file_type	File type (`GEOCOM_FTR_FILETYPE`).
character(len=*),	intent(in)	::	file_name	File name with extension.
integer,	intent(in)	::	block_size	Block size.

public pure subroutine dm_geocom_api_request_setup_list(request, device_type, file_type, search_path)

Request of FTR_SetupList procedure. Creates request for setting up file listing.

Arguments

Type	Intent	Optional		Name
type(request_type),	intent(out)		::	request	Prepared request.
integer,	intent(in)		::	device_type	Device type (`GEOCOM_FTR_DEVICETYPE`).
integer,	intent(in)		::	file_type	File type (`GEOCOM_FTR_FILETYPE`).
character(len=*),	intent(in),	optional	::	search_path	Optional search path, required for file type `GEOCOM_FTR_FILE_UNKNOWN`.

public pure subroutine dm_geocom_api_request_start_controller(request, start_mode)

Request of MOT_StartController procedure. Creates request for starting the motor controller.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	start_mode	Controller start mode (`GEOCOM_MOT_MODE`).

public pure subroutine dm_geocom_api_request_stop_controller(request, stop_mode)

Request of MOT_StartController procedure. Creates request for stopping the motor controller.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	stop_mode	Controller stop mode (`GEOCOM_MOT_STOPMODE`).

public pure subroutine dm_geocom_api_request_switch_off(request, stop_mode)

Request of COM_SwitchOffTPS procedure. Creates request for turning the instrument off.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	stop_mode	Switch-off mode (`GEOCOM_COM_TPS_STOP_MODE`).

public pure subroutine dm_geocom_api_request_switch_on(request, start_mode)

Request of COM_SwitchOnTPS procedure. Creates request for turning the instrument on.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	start_mode	Switch-on mode (`GEOCOM_COM_TPS_STARTUP_MODE`).

public pure subroutine dm_geocom_api_request_take_image(request, mem_type)

Request of IMG_TakeTccImage procedure. Creates request for capturing a telescope image.

Arguments

Type	Intent	Optional	Attributes		Name
type(request_type),	intent(out)			::	request	Prepared request.
integer,	intent(in)			::	mem_type	Memory type (`GEOCOM_IMG_MEM_TYPE`).

dm_geocom_api Module

Contents

Subroutines

API

Uses

Used by

Subroutines

public pure subroutine dm_geocom_api_request(request, name, code, arguments, pattern, responses, mode)

Arguments

public pure subroutine dm_geocom_api_request_abort_download(request)

Arguments

public pure subroutine dm_geocom_api_request_abort_list(request)

Arguments

public pure subroutine dm_geocom_api_request_beep_alarm(request)

Arguments

public pure subroutine dm_geocom_api_request_beep_normal(request)

Arguments

public pure subroutine dm_geocom_api_request_beep_off(request)

Arguments

public pure subroutine dm_geocom_api_request_beep_on(request, intensity)

Arguments

public pure subroutine dm_geocom_api_request_change_face(request, pos_mode, atr_mode)

Arguments

public pure subroutine dm_geocom_api_request_delete(request, device_type, file_type, day, month, year, file_name)

Arguments

public pure subroutine dm_geocom_api_request_do_measure(request, tmc_prog, inc_mode)

Arguments

public pure subroutine dm_geocom_api_request_download(request, block_number)

Arguments

public pure subroutine dm_geocom_api_request_fine_adjust(request, search_hz, search_v)

Arguments

public pure subroutine dm_geocom_api_request_get_angle(request, inc_mode)

Arguments

public pure subroutine dm_geocom_api_request_get_angle_complete(request, inc_mode)

Arguments

public pure subroutine dm_geocom_api_request_get_angle_correction(request)

Arguments

public pure subroutine dm_geocom_api_request_get_atmospheric_correction(request)

Arguments

public pure subroutine dm_geocom_api_request_get_atmospheric_ppm(request)

Arguments

public pure subroutine dm_geocom_api_request_get_atr_error(request)

Arguments

public pure subroutine dm_geocom_api_request_get_atr_setting(request)

Arguments

public pure subroutine dm_geocom_api_request_get_binary_mode(request)

Arguments

public pure subroutine dm_geocom_api_request_get_config(request)

Arguments

public pure subroutine dm_geocom_api_request_get_coordinate(request, wait_time, inc_mode)

Arguments

public pure subroutine dm_geocom_api_request_get_date_time(request)

Arguments

public pure subroutine dm_geocom_api_request_get_date_time_centi(request)

Arguments

public pure subroutine dm_geocom_api_request_get_device_config(request)

Arguments

public pure subroutine dm_geocom_api_request_get_double_precision(request)

Arguments

public pure subroutine dm_geocom_api_request_get_edm_mode(request)

Arguments

public pure subroutine dm_geocom_api_request_get_egl_intensity(request)

Arguments

public pure subroutine dm_geocom_api_request_get_face(request)

Arguments

public pure subroutine dm_geocom_api_request_get_fine_adjust_mode(request)

Arguments

public pure subroutine dm_geocom_api_request_get_full_measurement(request, wait_time, inc_mode)

Arguments

public pure subroutine dm_geocom_api_request_get_geocom_version(request)

Arguments

public pure subroutine dm_geocom_api_request_get_geometric_ppm(request)

Arguments

public pure subroutine dm_geocom_api_request_get_height(request)

Arguments

public pure subroutine dm_geocom_api_request_get_image_config(request, mem_type)

Arguments

public pure subroutine dm_geocom_api_request_get_inclination_correction(request)

Arguments

public pure subroutine dm_geocom_api_request_get_inclination_error(request)