GeoCOM Reference Manual 4. Remarks on the Description 4 REMARKS ON THE DESCRIPTION This chapter contains some remarks on the description of RPC's and on the structure of the descriptions 4.1 STRUCTURE OF DESCRIPTIONS The whole reference part is subdivided into sections. Each section contains descriptions of a set of functions, which build up a subsystem. A subsystem gathers all functions, which are related to a specific functionality of a TPS1 100 instrument e.g. MOT describes all functions, which relate to motorization. Each subsystem is subdivided into the descriptions of RPC's 4.1.1 Structure of a Subsystem A subsystem consists of the following parts sage This part gives some hints about the usage of the subsystem and general information of its functionality 2. Constants and Types All subsystem specific constants and data types are listed here. Also their meanings are described if they are not obvious 3. Functions All RPC's of this subsystems are listed here and described in detail Note: To reduce redundancy the vB declarations of data types and constants have been omitted. Please refer to chapter 3.3 to get more information about this 4.1.2 Structure of a RPC Description One rPC description contains the following parts Title Contains the name of the RPC and a short description of the function TPS1100-Version l01
GeoCOM Reference Manual 4 . Remarks on the Description TPS1100-Version 1.01 4-1 4 REMARKS ON THE DESCRIPTION This chapter contains some remarks on the description of RPC’s and on the structure of the descriptions. 4.1 STRUCTURE OF DESCRIPTIONS The whole reference part is subdivided into sections. Each section contains descriptions of a set of functions, which build up a subsystem. A subsystem gathers all functions, which are related to a specific functionality of a TPS1100 instrument, e.g. MOT describes all functions, which relate to motorization. Each subsystem is subdivided into the descriptions of RPC’s. 4.1.1 Structure of a Subsystem A subsystem consists of the following parts: 1. Usage This part gives some hints about the usage of the subsystem and general information of its functionality. 2. Constants and Types All subsystem specific constants and data types are listed here. Also their meanings are described if they are not obvious. 3. Functions All RPC’s of this subsystems are listed here and described in detail. Note: To reduce redundancy the VB declarations of data types and constants have been omitted. Please refer to chapter 3.3 to get more information about this subject. 4.1.2 Structure of a RPC Description One RPC description contains the following parts: Title Contains the name of the RPC and a short description of the function
GeoCOM Reference M 4. Remarks on the Description C-Declaration Contains the C declaration of the function(excluding the return type) VB-Declaration Declares the function in VB (excluding the return type) ASCIl-Request Describes the composition, inclusive the base types, of the asCiI reques ASCIl-Reply Describes the composition, inclusive the base types, of the corresponding Remark Gives additional information on the usage and possible side effects of the Parameters Explains the parameters, their data types and their meaning Return-Codes Gives the meaning of the return codes related to this RPC. General and ommunication return codes will be omitted in explanations. They are lained in 3.6 See also Cross references shows other rPC's which relate to this one Example Gives an example of how this rPc could be used Note: To reduce redundancy the return type has been omitted from the C- and VB-declarations of the rpc's ASCIl-Request and Reply do not explain the whole data structures. Instead the corresponding base types will be given. Please refer to chapter 2.2 to get more information on this topic Also because of redundancy the necessary Cr/lf at the end has been omitted from ASCIl-Request and Reply TPS1100-Version l01
GeoCOM Reference Manual 4 . Remarks on the Description TPS1100-Version 1.01 4-2 C-Declaration Contains the C declaration of the function (excluding the return type). VB-Declaration Declares the function in VB (excluding the return type). ASCII-Request Describes the composition, inclusive the base types, of the ASCII request. ASCII-Reply Describes the composition, inclusive the base types, of the corresponding reply. Remarks Gives additional information on the usage and possible side effects of the function. Parameters Explains the parameters, their data types and their meaning. Return-Codes Gives the meaning of the return codes related to this RPC. General and communication return codes will be omitted in explanations. They are explained in 3.6. See Also Cross references shows other RPC’s which relate to this one. Example Gives an example of how this RPC could be used. Note: To reduce redundancy the return type has been omitted from the C- and VB-declarations of the RPC’s. ASCII-Request and Reply do not explain the whole data structures. Instead the corresponding base types will be given. Please refer to chapter 2.2 to get more information on this topic. Also because of redundancy the necessary CR/LF at the end has been omitted from ASCII-Request and Reply
GeoCOM Reference Manual 4. Remarks on the Description 4.1.3 Sample of a RPC Description 1.1.1 CSV GetDate Time- Get date and time C-Declaration Title and description csv Get DateTime( DATIME &DateAndTime VB-Declaration B cSV GetDateTime\(DateAndTime As DATIME) ASCll-Request Declarations for ASCII-Response different protocols SRIP,0, 0: RC, Year(short), Month, Day, Hour, Minute, Second/all byte/ The ASCiI respons Remarks to this function and its usage type DATIME. A possible response can look like 各R1P,0,0:0,1996,'07','19','10',"13',2f'(See hapter ASCII data type declaration for further information) Parameters Detailed descriptions of parameters DateAndTime out Encoded date and time Return-Codes Meaning of return codes RC OK RC UNDEFINED Time and/or date is not set (yet) See also csv SetDateTime / Cross references to related fund Example DATIME rc cSV GetDaterime(DateAXGTi a typical usage if (rc / use Date and time else / handle error TPS1100-Version l01
GeoCOM Reference Manual 4 . Remarks on the Description TPS1100-Version 1.01 4-3 4.1.3 Sample of a RPC Description 1.1.1 CSV_GetDateTime- Get date and time. C-Declaration CSV_GetDateTime(DATIME &DateAndTime) VB-Declaration VB_CSV_GetDateTime (DateAndTime As DATIME) ASCII-Request %R1Q,5008: ASCII-Response %R1P,0,0:RC,Year[short],Month,Day,Hour,Minute,Second[all byte] Remarks The ASCII response is formated corresponding to the data type DATIME. A possible response can look like this: %R1P,0,0:0,1996,'07', '19','10','13','2f' (see chapter ASCII data type declaration for further information) Parameters DateAndTime out Encoded date and time. Return-Codes RC_OK Execution successful. RC_UNDEFINED Time and/or date is not set (yet). See Also CSV_SetDateTime Example RC_TYPE rc; DATIME DateAndTime; rc = CSV_GetDateTime(DateAndTime); if (rc == RC_OK) { // use Date and time } else { // handle error Title and description Declarations for different protocols Detailed descriptions of parameters Meaning of return codes Cross references to related functions A typical usage of this function Remarks to this function and its usage
GeoCOM Reference Manual 5 COMMUNICATION SETTINGS This subsystem provides functions which influences GeoCOM as a whole and functions, which relate to the client side only If a function influences the client side only then there is no ASCiI request defined 5.1 CONSTANTS AND TYPES Serial port selector This enumeration type denotes the hardware serial port enum COM PORT COM 4=3 Transmission Data Format This value tells if the transmission takes place in a readable AsCll data format or in a data size optimised binary data format. num COM FORMAT COM ASCII =0, // Force ASCII comm COM BINARY ∥ Enable binary comm Baud rate enum COM BAUD RATE COM BAUD 38400=0 COM BAUD 19200 =1, // default baud rate COM BAUD 9600 =2 COM BAUD 4800 =3, TPS1100-Version l01
GeoCOM Reference Manual 5 . Communication Settings TPS1100-Version 1.01 5-1 5 COMMUNICATION SETTINGS This subsystem provides functions which influences GeoCOM as a whole and functions, which relate to the client side only. If a function influences the client side only then there is no ASCII request defined. 5.1 CONSTANTS AND TYPES Serial Port Selector This enumeration type denotes the hardware serial port. enum COM_PORT { COM_1 = 0, // port 1 COM_2 = 1, // port 2 COM_3 = 2, // port 3 COM_4 = 3 // port 4 }; Transmission Data Format This value tells if the transmission takes place in a readable ASCII data format or in a data size optimised binary data format. enum COM_FORMAT { COM_ASCII = 0, // Force ASCII comm. COM_BINARY = 1 // Enable binary comm. }; Baud Rate enum COM_BAUD_RATE { COM_BAUD_38400 = 0, COM_BAUD_19200 = 1, // default baud rate COM_BAUD_9600 = 2, COM_BAUD_4800 = 3, COM_BAUD_2400 = 4 };
GeoCOM Reference Manual TPS1100 Operation Status enum COM TPS STATUS COM TPS OFF =0,∥ switched off COM_TPS_SLEEPING =1, //sleep mode COM TPS ONLINE =2, //online mode COM TPS LOCAL =3,∥/ local mode COM TPS UNKNOWN= M/ unknown or not initialised MS-Windows Data Types One of the described functions uses the predefined type HWND of MS-Windows Please refer to the documentation of MS-Windows development environment for his data type Note: HWND depends on whether the pre-processor symbol sTRICT is defined When MFC libraries are used, STRICT is automatically defined. Otherwise the user must #define StrIct or he will get unresolved externals 5.2 GENERAL GEOCOM FUNCTIONS 5.2.1 COM Get DoublePrecision -Get Double Precision Setting C-Declaration COM GetDoublePrecision( short &nDigits VB-Declaration VB COM GetDoublePrecision( nDigits As Integer ASCll-Request ASCII-Response BRIP,0,0: RC, nDigits [short] Remarks This function returns the precision- number of digits to the right of the decimal point-when double floating-point values are transmitted. The ge of this function is only meaningful if the communication is set to TPS1100-Version l01
GeoCOM Reference Manual 5 . Communication Settings TPS1100-Version 1.01 5-2 TPS1100 Operation Status enum COM_TPS_STATUS { COM_TPS_OFF = 0, // switched off COM_TPS_SLEEPING = 1, // sleep mode COM_TPS_ONLINE = 2, // online mode COM_TPS_LOCAL = 3, // local mode COM_TPS_UNKNOWN = 4 // unknown or not initialised }; MS-Windows Data Types One of the described functions uses the predefined type HWND of MS-Windows. Please refer to the documentation of MS-Windows development environment for this data type. Note: HWND depends on whether the pre-processor symbol STRICT is defined. When MFC libraries are used, STRICT is automatically defined. Otherwise the user must #define STRICT or he will get unresolved externals. 5.2 GENERAL GEOCOM FUNCTIONS 5.2.1 COM_GetDoublePrecision - Get Double Precision Setting C-Declaration COM_GetDoublePrecision( short &nDigits ) VB-Declaration VB_COM_GetDoublePrecision( nDigits As Integer ) ASCII-Request %R1Q,108: ASCII-Response %R1P,0,0:RC,nDigits[short] Remarks This function returns the precision – number of digits to the right of the decimal point – when double floating-point values are transmitted. The usage of this function is only meaningful if the communication is set to