ISO/IEC 18042-4:2006(E) -- 6 Function definitions

The SRM C binding method name is formed by a sentinal “SRM_” followed by the name without spaces and with words capitalized. The SRM abstract method name is the name used in ISO/IEC 18026. Parameter 0 of a method is always a pointer to the associated object.

Independent functions (including all Create functions) are bound in a manner similar to that used by object methods except that Parameter 0 is not constrained to be a pointer to the current object. In most cases, the independent functions are producing an object instance.

The return value data type and parameter data types may be found in Clause 5 of this part of ISO/IEC 18042 or may be a standard C data type (e.g., void).

The parameter names are formed by using lower case words separated by underscores.

To the right of each parameter declaration is an optional C comment field. If the comment begins with “OUT”, it means the argument is used as an output parameter; the implementation returns data to the application through this argument. Arguments without “OUT” are input parameters.

Each SRM concrete object class is bound to a data type that is specified as a structure containing a pointer to its state and another pointer to its list of methods as depicted in the following template:

The state is an implementation-dependent private data type that is accessed solely through the methods in the method list.

Each method list for a SRM concrete object class is a data type that is specified as a structure containing a pointer to each method supported by the object class as depicted in the following template:

NOTE Instances of this data type are normally populated by the implementation during object creation.

6.2 SRM abstract object method signatures

6.2.1 Overview

Method signatures for SRM abstract objects are specified here for use when specifying concrete object classes (see 6.3 SRM concrete object classes).

6.2.2 LifeCycleObject

6.2.3 BaseSRF

6.2.4 BaseSRF2D

6.2.5 BaseSRF3D

6.2.6 BaseSRFwithTangentPlaneSurface

6.2.7 BaseSRFwithEllipsoidalHeight

6.2.8 BaseSRFMapProjection

6.3 SRM concrete object classes

6.3.1 Overview

Concrete SRM objects are defined by a combination of methods and functions defined for the abstract object classes as specified in 6.2 SRM Abstract object method signatures and new methods and data types specified for each concrete object class. Objects may be created by using the Create function that accompanies each object class. The Create function accepts parameters that specify the characteristics of an object and returns a pointer to the object that is created. Object classes not specifying a Create function use that specified in 6.2.2 LifeCycleObject.

6.3.2 Celestiocentric

The following function specifies the binding of the factory for the Celestiocentric object class:

The following data type is used to specify the methods of the Celestiocentric object class:

The following record type specifies the binding of the Celestocentric object class:

6.3.3 Celestiodetic

The following function specifies the binding of the factory for the Celestiodetric object class:

Parameter0DataType	parameter_0_name,	/* parameter_0_comment */
Parameter1DataType	parameter_1_name,	/* parameter_1_comment */
• • •
ParameterNDataType	parameter_N_name	/* parameter_N_comment */

void	*state;
Method_List_Data_Type	*methods;

Method_0_Data_Type	*method_0_name;
Method_1_Data_Type	*method_1_name;
• • •
Method_N_Data_Type	*method_N_name;

	SRM_Object_Reference	this_object,
	SRM_CS_Code	*cs_code	/* OUT cs code */

SRM_Object_Reference	this_object,
SRM_ORM_Code	*orm_code,	/* OUT */
SRM_RT_Code	*rt_code	/* OUT */

SRM_Object_Reference	this_object,
SRM_SRFT_Code	*srft_code,	/* OUT srf template code */
SRM_SRF_Code	*srf_code,	/* OUT srf code */
SRM_SRFS_Code_Info	*srfs_code_info	/* OUT srf set code info */

	SRM_Object_Reference	this_object,
const	SRM_Object_Reference	source_srf,
const	SRM_Coordinate2D_Array	*source_coordinate_array,
	SRM_Coordinate2D_Array	*target_coordinate_array,	/* OUT */
	SRM_Integer_Positive	*index	/* OUT */

SRM_Object_Reference	this_object,
SRM_Long_Float	first_coordinate_component,
SRM_Long_Float	second_coordinate_component,
SRM_Coordinate2D	*new_coordinate	/* OUT */

SRM_Object_Reference	this_object,
SRM_Integer	component_identifier,
SRM_Interval_Type	*interval_type,	/* OUT */
SRM_Long_Float	*extended_lower_bound,	/* OUT */
SRM_Long_Float	*lower_bound,	/* OUT */
SRM_Long_Float	*upper_bound,	/* OUT */
SRM_Long_Float	*extended_upper_bound	/* OUT */

	SRM_Object_Reference	this_object,
	SRM_DSS_Code	dss_code,
const	SRM_SurfaceCoordinate	*surface_coordinate,
	SRM_Long_Float	*separation	/* OUT */

SRM_ORM_Code	orm_code,
SRM_RT_Code	rt_code,
SRM_Celestiocentric	*new_srf	/* OUT */

SRM_ChangeCoordinate3DArraySRF	*ChangeCoordinate3DArraySRF;
SRM_ChangeCoordinate3DArraySRFObject	*ChangeCoordinate3DArraySRFObject;
SRM_ChangeCoordinate3DSRF	*ChangeCoordinate3DSRF;
SRM_ChangeCoordinate3DSRFObject	*ChangeCoordinate3DSRFObject;
SRM_ChangeDirectionArraySRF	*ChangeDirectionArraySRF;
SRM_ChangeDirectionArraySRFObject	*ChangeDirectionArraySRFObject;
SRM_ChangeDirectionSRF	*ChangeDirectionSRF;
SRM_ChangeDirectionSRFObject	*ChangeDirectionSRFObject;
SRM_CreateCoordinate3D	*CreateCoordinate3D;
SRM_CreateDirection	*CreateDirection;
SRM_Destroy	*Destroy;
SRM_EuclideanDistance3D	*EuclideanDistance3D;
SRM_Generating3D	*Generating3D;
SRM_GetCoordinate3DValues	*GetCoordinate3DValues;
SRM_GetCSCode	*GetCSCode;
SRM_GetDirectionValues	*GetDirectionValues;
SRM_GetExtendedValidRegion	*GetExtendedValidRegion;
SRM_GetORMCodes	*GetORMCodes;
SRM_GetSRFCodes	*GetSRFCodes;
SRM_GetValidRegion	*GetValidRegion;
SRM_InverseGenerating3D	*InverseGenerating3D;
SRM_SetExtendedValidRegion	*SetExtendedValidRegion;
SRM_SetValidRegion	*SetValidRegion;