Main Page | Alphabetical List | Compound List | File List | Compound Members | File Members

srm_BaseSRFwithEllipsoidalHeight.h File Reference

#include "srm.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_AssociateSurfaceCoordinateEH (SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_SurfaceCoordinate *on_surface_coordinate)
typedef SRM_Status_Code SRM_CreateLocalTangentSpaceEuclideanSRF (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float azimuth, SRM_Long_Float false_x_origin, SRM_Long_Float false_y_origin, SRM_Long_Float offset_height, SRM_LocalTangentSpaceEuclidean *local_tangent_Euclidean_srf)
typedef SRM_Status_Code SRM_CreateSurfaceCoordinateEH (SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_SurfaceCoordinate *new_coordinate)
typedef SRM_Status_Code SRM_DestroySurfaceCoordinateEH (SRM_Object_Reference this_object, SRM_Object_Reference coordinate)
typedef SRM_Status_Code SRM_EuclideanDistanceEH (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance)
typedef SRM_Status_Code SRM_GeodesicDistance (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance)
typedef SRM_Status_Code SRM_GetSurfaceCoordinateValuesEH (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component)
typedef SRM_Status_Code SRM_PromoteSurfaceCoordinateEH (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Coordinate3D *coordinate)
typedef SRM_Status_Code SRM_VerticalOffset (SRM_Object_Reference this_object, SRM_DSS_Code dss_code, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *separation)

Define Documentation

#define EXPORT_DLL
 

Definition at line 82 of file srm_BaseSRFwithEllipsoidalHeight.h.

Typedef Documentation

typedef SRM_Status_Code SRM_AssociateSurfaceCoordinateEH( SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_SurfaceCoordinate *on_surface_coordinate )
 

Associate Surface Coordinate

Parameters:
this_object in: this SRF object
coordinate in: surface coordinate
on_surface_coordinate out: resulting in a surface coordinate
Returns:
a status code

Definition at line 106 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_CreateLocalTangentSpaceEuclideanSRF( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float azimuth, SRM_Long_Float false_x_origin, SRM_Long_Float false_y_origin, SRM_Long_Float offset_height, SRM_LocalTangentSpaceEuclidean *local_tangent_Euclidean_srf )
 

Creates a Local Tangent Space Euclidean SRF

Parameters:
this_object in: this SRF object
surface_coordinate in: SRF surface coordiante
azimuth in: azimuth
false_x_origin in: false x origin
false_y_origin in: false y origin
offset_height in: offset height
local_tangent_Euclidean_srf out: this SRF object
Returns:
a status code

Definition at line 123 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_CreateSurfaceCoordinateEH( SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_SurfaceCoordinate *new_coordinate )
 

Creates a Ellipsoidal Height surface coordinate object.

Parameters:
this_object in: this SRF object
first_coordinate_component in: this is the first coordinate of the two
second_coordinate_component in: second coordinate
new_coordinate out: resulting in a new coordinate
Returns:
a status code

Definition at line 141 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_DestroySurfaceCoordinateEH( SRM_Object_Reference this_object, SRM_Object_Reference coordinate )
 

Destroys the Ellipsoidal Height surface coordinate

Parameters:
this_object in: this SRF object
coordinate in: coordinate to be destroyed
Returns:
a status code

Definition at line 154 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_EuclideanDistanceEH( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance )
 

This is the Euclidean Distance Ellipsoidal Height

Parameters:
this_object in: this SRF object
point1_coordinate in: Ellposoidal Height surface coordinate
point2_coordinate in: Ellposoidal Height target surface coordinate
distance out: resulting in the distance between the two points
Returns:
a status code

Definition at line 167 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_GeodesicDistance( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *distance )
 

This is the Geodesic Distance

Parameters:
this_object in: this SRF object
point1_coordinate in: Geodesic Distance surface coordinate
point2_coordinate in: Geodesic Distance target surface coordinate
distance out: resulting in the distance between the two points
Returns:
a status code

Definition at line 182 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_GetSurfaceCoordinateValuesEH( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component )
 

Retrieves the Surface Coordinate values for Ellipsoidal Height

Parameters:
this_object in: this SRF object
coordinate in: surface coordinate
first_coordinate_component out: this is the first coordinate component
second_coordinate_component out: this is the second coordinate component
Returns:
a status code

Definition at line 197 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_PromoteSurfaceCoordinateEH( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Coordinate3D *coordinate )
 

This is a 3D coordinate representing the same location as specified by a surface coordinate.

Parameters:
this_object in: this SRF object
surface_coordinate in: this is the surface coordinate
coordinate out: this is the 3D new coordinate
Returns:
a status code

Definition at line 212 of file srm_BaseSRFwithEllipsoidalHeight.h.

typedef SRM_Status_Code SRM_VerticalOffset( SRM_Object_Reference this_object, SRM_DSS_Code dss_code, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *separation )
 

Returns the Vertical Offset (in metres) at a position.

Parameters:
this_object in: this SRF object
dss_code in: this is the vertical offset
surface_coordinate in: surface coordinate for the object
separation out: resulting in the separation for the object
Returns:
a status code

Definition at line 226 of file srm_BaseSRFwithEllipsoidalHeight.h.

C API Version: 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™ Docs by Doxygen 1.3.2