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

srm_BaseMapProjection.h File Reference

#include "srm.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_ConvergenceOfTheMeridian (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *gamma)
typedef SRM_Status_Code SRM_GetExtendedValidGeodeticRegion (SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type *interval_type, SRM_Long_Float *extended_lower_bound, SRM_Long_Float *lower_bound, SRM_Long_Float *upper_bound, SRM_Long_Float *extended_upper_bound)
typedef SRM_Status_Code SRM_GetValidGeodeticRegion (SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type *interval_type, SRM_Long_Float *lower_bound, SRM_Long_Float *upper_bound)
typedef SRM_Status_Code SRM_MapAzimuth (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *azimuth)
typedef SRM_Status_Code SRM_PointDistortion (SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *distortion)
typedef SRM_Status_Code SRM_SetExtendedValidGeodeticRegion (SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type interval_type, SRM_Long_Float extended_lower_bound, SRM_Long_Float lower_bound, SRM_Long_Float upper_bound, SRM_Long_Float extended_upper_bound)
typedef SRM_Status_Code SRM_SetValidGeodeticRegion (SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type interval_type, SRM_Long_Float lower_bound, SRM_Long_Float upper_bound)

Define Documentation

#define EXPORT_DLL
 

Definition at line 82 of file srm_BaseMapProjection.h.

Typedef Documentation

typedef SRM_Status_Code SRM_ConvergenceOfTheMeridian( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *gamma )
 

This is the ConvergenceOfMeridian.

Parameters:
this_object in: this SRF object
surface_coordinate in: surface coordinate
gamma out: resulting convergence of the meridian
Returns:
a status code

Definition at line 106 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_GetExtendedValidGeodeticRegion( SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type *interval_type, SRM_Long_Float *extended_lower_bound, SRM_Long_Float *lower_bound, SRM_Long_Float *upper_bound, SRM_Long_Float *extended_upper_bound )
 

Gets the Extended Valid Geodetic Region for this SRF. This is the Lat/Long Coordinates.

Note:
Given a coordinate component, the last invocation of this method or the setValidGeodeticRegion method determines the valid and extended valid intervals of the coordinate component values.
Parameters:
this_object in: this SRF object
component_identifier in: the coordinate component (1, 2, or 3)
interval_type out: the type of interval
extendend_lower_bound out: the extended lower value of the interval
lower_bound out: the lower value of the interval
upper_bound out: the upper value of the interval
extended_upper_bound out: the extended_upper value of the interval
Returns:
a status code

Definition at line 128 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_GetValidGeodeticRegion( SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type *interval_type, SRM_Long_Float *lower_bound, SRM_Long_Float *upper_bound )
 

Get the Valid Geodetic Region for this SRF.

Note:
: Given a coordinate component, the last invocation of this method or the setExtendedValidGeodeticRegion method determines the valid and extended valid intervals of the coordinate component values.
Parameters:
this_object in: this SRF object
component_identifier in: the coordinate component (1 or 2)
interval_type out: the type of the interval
lower_bound out: the lower value of the interval
upper_bound out: the upper value of the interval
Returns:
a status code

Definition at line 151 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_MapAzimuth( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *point1_coordinate, const SRM_SurfaceCoordinate *point2_coordinate, SRM_Long_Float *azimuth )
 

This is the MapAzimith for the SRF

Note:
What is Azimith
Parameters:
this_object in: this SRF object
point1_coordinate in: surface coordinate
point2_coordinate in: target coordinate
azimuth out: result is azimuth
Returns:
a status code

Definition at line 168 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_PointDistortion( SRM_Object_Reference this_object, const SRM_SurfaceCoordinate *surface_coordinate, SRM_Long_Float *distortion )
 

Point Distortion for the SRF

Note:
Parameters:
this_object in: this SRF object
surface_coordinate in: surface coordinate
distortion in: returning distortion
Returns:
a status code

Definition at line 183 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_SetExtendedValidGeodeticRegion( SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type interval_type, SRM_Long_Float extended_lower_bound, SRM_Long_Float lower_bound, SRM_Long_Float upper_bound, SRM_Long_Float extended_upper_bound )
 

Set the Extended Valid Region for this SRF.

Note:
Given a coordinate component, the last invocation of this method or the setValidRegion method determines the valid and extended valid intervals of the coordinate component values.

Upper or Lower value is ignored if the interval is a semi-interval or unbounded.

The Lower value must be strictly less than the Upper value.

The Extended_Lower value must be strictly greater than the Lower value and the Extended_Upper value must be strictly smaller than the Lower value.

Parameters:
this_object in: this SRF object
component_identifier in: the coordinate component (1, 2, or 3)
interval_type in: the type of interval
extended_lower_bound in: the extended lower value of the interval
lower_bound in: the lower value of the interval
upper_bound in: the upper value of the interval
extended_upper_bound in: the extended_upper value of the interval
Returns:
a status code

Definition at line 209 of file srm_BaseMapProjection.h.

typedef SRM_Status_Code SRM_SetValidGeodeticRegion( SRM_Object_Reference this_object, SRM_Integer component_identifier, SRM_Interval_Type interval_type, SRM_Long_Float lower_bound, SRM_Long_Float upper_bound )
 

Set the Valid Region for this SRF in geodetic coordinates (lon/lat).

Note:
Given a coordinate component, the last invocation of this method or the setExtendedValidGeodeticRegion method determines the valid and extended valid intervals of the coordinate component values.

Upper or Lower value is ignored if the interval is a semi-interval or unbounded.

The Lower value must be strictly less than the Upper bound value.

Parameters:
this_object in: this SRF object
component_identifier in: the coordinate component (1 or 2)
interval_type in: the type of interval
lower_bound in: the lower bound value of the interval
upper_bound in: the upper bound value of the interval
Returns:
a status code

Definition at line 235 of file srm_BaseMapProjection.h.

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