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

srm_valid.h File Reference

This file defines the prototypes for the functions that validate the data structures used by the SRM API; it is included by srm.h. More...

#include <stdio.h>
#include "srm_types.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Functions

EXPORT_DLL FILE * SRM_GetErrorFilePtr (void)
EXPORT_DLL SRM_Status_Code SRM_SetErrorFilePtr (FILE *err_file_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidAxisDirection (SRM_Axis_Direction value)
EXPORT_DLL SRM_Boolean SRM_ValidBoolean (SRM_Boolean value)
EXPORT_DLL SRM_Boolean SRM_ValidCD3DCoordinate (const SRM_CD_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCDSurfaceCoordinate (const SRM_CD_Surface_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCoordinate (const SRM_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCoordinateValidRegion (SRM_Coordinate_Valid_Region value)
EXPORT_DLL SRM_Boolean SRM_ValidCoordinateValidRegionArray (const SRM_Coordinate_Valid_Region_Array *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCoordinate2DArray (const SRM_Coordinate2D_Array *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCoordinate3DArray (const SRM_Coordinate3D_Array *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidCSCode (SRM_CS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidDirectionArray (const SRM_Direction_Array *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidDSSCode (SRM_DSS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidECParameters (const SRM_EC_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidEI3DCoordinate (const SRM_EI_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidIntegerPositive (SRM_Integer_Positive value)
EXPORT_DLL SRM_Boolean SRM_ValidIntervalType (SRM_Interval_Type value)
EXPORT_DLL SRM_Boolean SRM_ValidLocalTangentParameters (const SRM_Local_Tangent_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLSA2DCoordinate (const SRM_LSA_2D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLSP2DCoordinate (const SRM_LSP_2D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLSR2DParameters (const SRM_LSR_2D_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLSR3DParameters (const SRM_LSR_3D_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLTSAS3DCoordinate (const SRM_LTSAS_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLTSC3DCoordinate (const SRM_LTSC_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLTSCSurfaceCoordinate (const SRM_LTSC_Surface_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidLTSEParameters (const SRM_LTSE_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidMParameters (const SRM_M_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidObliqueMercatorParameters (const SRM_Oblique_Mercator_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidORMCode (SRM_ORM_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidORMTCode (SRM_ORMT_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidPD3DCoordinate (const SRM_PD_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidPDSurfaceCoordinate (const SRM_PD_Surface_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidPolarAspect (SRM_Polar_Aspect value)
EXPORT_DLL SRM_Boolean SRM_ValidPSParameters (const SRM_PS_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidRDCode (SRM_RD_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidRTCode (SRM_ORM_Code orm_code, SRM_RT_Code rt_code)
EXPORT_DLL SRM_Boolean SRM_ValidSpatialCoordinateCode (SRM_Spatial_Coordinate_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSpherical3DCoordinate (const SRM_Spherical_3D_Coordinate *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidSRFCode (SRM_SRF_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFParametersInfo (const SRM_SRF_Parameters_Info *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidSRFParametersInfoCode (SRM_SRF_Parameters_Info_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFReferenceSurfaceInfo (const SRM_SRF_Reference_Surface_Info *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSCode (SRM_SRFS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSCodeInfo (const SRM_SRFS_Code_Info *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSInfo (const SRM_SRFS_Info *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMAlabamaSPCSCode (SRM_SRFSM_Alabama_SPCS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMJapanRectangularPlaneCSCode (SRM_SRFSM_Japan_Rectangular_Plane_CS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMLambertNTFCode (SRM_SRFSM_Lambert_NTF_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMUPSCode (SRM_SRFSM_UPS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMUTMCode (SRM_SRFSM_UTM_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFSMWisconsinSPCSCode (SRM_SRFSM_Wisconsin_SPCS_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFTCode (SRM_SRFT_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidSRFTParameters (const SRM_SRFT_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)
EXPORT_DLL SRM_Boolean SRM_ValidStatusCode (SRM_Status_Code value)
EXPORT_DLL SRM_Boolean SRM_ValidTMParameters (const SRM_TM_Parameters *value_ptr, SRM_Boolean print_error, SRM_Integer_Unsigned *error_count_ptr)


Detailed Description

This file defines the prototypes for the functions that validate the data structures used by the SRM API; it is included by srm.h.

Author:
Automatically generated file

Note:
This file is for internal use only. Users must not include this file, but instead include srm.h.

Definition in file srm_valid.h.


Define Documentation

#define EXPORT_DLL
 

Definition at line 34 of file srm_valid.h.


Function Documentation

EXPORT_DLL FILE* SRM_GetErrorFilePtr void   ) 
 

Returns the FILE pointer to which error messages are directed.

Returns:
FILE pointer to stream to which error messages are to be output.

EXPORT_DLL SRM_Status_Code SRM_SetErrorFilePtr FILE *  err_file_ptr  ) 
 

Sets the FILE pointer to which error messages are directed, if error messages are requested.

Warning:
If you close this file after calling this function, remember that the SRM functions will still try to use it.
Parameters:
err_file_ptr -- stream to which error messages are to be output
Returns:
SRM_STATCOD_INACTIONABLE - and nothing is changed, if err_file_ptr is NULL.

SRM_STATCOD_SUCCESS - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidAxisDirection SRM_Axis_Direction  value  ) 
 

Checks if the given value is a valid SRM_Axis_Direction.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidBoolean SRM_Boolean  value  ) 
 

Checks if the given value is a valid SRM_Boolean.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidCD3DCoordinate const SRM_CD_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_CD_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_CD_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_CD_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCDSurfaceCoordinate const SRM_CD_Surface_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_CD_Surface_Coordinate.

Parameters:
value_ptr -- pointer to SRM_CD_Surface_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_CD_Surface_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCoordinate const SRM_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Coordinate.

Parameters:
value_ptr -- pointer to SRM_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCoordinate2DArray const SRM_Coordinate2D_Array value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Coordinate2D_Array.

Parameters:
value_ptr -- pointer to SRM_Coordinate2D_Array whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Coordinate2D_Array is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCoordinate3DArray const SRM_Coordinate3D_Array value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Coordinate3D_Array.

Parameters:
value_ptr -- pointer to SRM_Coordinate3D_Array whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Coordinate3D_Array is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCoordinateValidRegion SRM_Coordinate_Valid_Region  value  ) 
 

Checks if the given value is a valid SRM_Coordinate_Valid_Region.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidCoordinateValidRegionArray const SRM_Coordinate_Valid_Region_Array value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Coordinate_Valid_Region_Array.

Parameters:
value_ptr -- pointer to SRM_Coordinate_Valid_Region_Array whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Coordinate_Valid_Region_Array is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidCSCode SRM_CS_Code  value  ) 
 

Checks if the given value is a valid SRM_CS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidDirectionArray const SRM_Direction_Array value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Direction_Array.

Parameters:
value_ptr -- pointer to SRM_Direction_Array whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Direction_Array is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidDSSCode SRM_DSS_Code  value  ) 
 

Checks if the given value is a valid SRM_DSS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidECParameters const SRM_EC_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_EC_Parameters.

Parameters:
value_ptr -- pointer to SRM_EC_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_EC_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidEI3DCoordinate const SRM_EI_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_EI_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_EI_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_EI_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidIntegerPositive SRM_Integer_Positive  value  ) 
 

Checks that the given SRM_Integer_Positive contains a valid value.

Parameters:
value -- SRM_Integer_Positive whose contents are to be processed
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidIntervalType SRM_Interval_Type  value  ) 
 

Checks if the given value is a valid SRM_Interval_Type.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidLocalTangentParameters const SRM_Local_Tangent_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Local_Tangent_Parameters.

Parameters:
value_ptr -- pointer to SRM_Local_Tangent_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Local_Tangent_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLSA2DCoordinate const SRM_LSA_2D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LSA_2D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_LSA_2D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LSA_2D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLSP2DCoordinate const SRM_LSP_2D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LSP_2D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_LSP_2D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LSP_2D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLSR2DParameters const SRM_LSR_2D_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LSR_2D_Parameters.

Parameters:
value_ptr -- pointer to SRM_LSR_2D_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LSR_2D_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLSR3DParameters const SRM_LSR_3D_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LSR_3D_Parameters.

Parameters:
value_ptr -- pointer to SRM_LSR_3D_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LSR_3D_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLTSAS3DCoordinate const SRM_LTSAS_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LTSAS_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_LTSAS_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LTSAS_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLTSC3DCoordinate const SRM_LTSC_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LTSC_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_LTSC_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LTSC_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLTSCSurfaceCoordinate const SRM_LTSC_Surface_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LTSC_Surface_Coordinate.

Parameters:
value_ptr -- pointer to SRM_LTSC_Surface_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LTSC_Surface_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidLTSEParameters const SRM_LTSE_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_LTSE_Parameters.

Parameters:
value_ptr -- pointer to SRM_LTSE_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_LTSE_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidMParameters const SRM_M_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_M_Parameters.

Parameters:
value_ptr -- pointer to SRM_M_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_M_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidObliqueMercatorParameters const SRM_Oblique_Mercator_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Oblique_Mercator_Parameters.

Parameters:
value_ptr -- pointer to SRM_Oblique_Mercator_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Oblique_Mercator_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidORMCode SRM_ORM_Code  value  ) 
 

Checks if the given value is a valid SRM_ORM_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidORMTCode SRM_ORMT_Code  value  ) 
 

Checks if the given value is a valid SRM_ORMT_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidPD3DCoordinate const SRM_PD_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_PD_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_PD_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_PD_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidPDSurfaceCoordinate const SRM_PD_Surface_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_PD_Surface_Coordinate.

Parameters:
value_ptr -- pointer to SRM_PD_Surface_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_PD_Surface_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidPolarAspect SRM_Polar_Aspect  value  ) 
 

Checks if the given value is a valid SRM_Polar_Aspect.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidPSParameters const SRM_PS_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_PS_Parameters.

Parameters:
value_ptr -- pointer to SRM_PS_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_PS_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidRDCode SRM_RD_Code  value  ) 
 

Checks if the given value is a valid SRM_RD_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidRTCode SRM_ORM_Code  orm_code,
SRM_RT_Code  rt_code
 

Checks if the given value is a valid SRM_RT_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSpatialCoordinateCode SRM_Spatial_Coordinate_Code  value  ) 
 

Checks if the given value is a valid SRM_Spatial_Coordinate_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSpherical3DCoordinate const SRM_Spherical_3D_Coordinate value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_Spherical_3D_Coordinate.

Parameters:
value_ptr -- pointer to SRM_Spherical_3D_Coordinate whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_Spherical_3D_Coordinate is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidSRFCode SRM_SRF_Code  value  ) 
 

Checks if the given value is a valid SRM_SRF_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFParametersInfo const SRM_SRF_Parameters_Info value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_SRF_Parameters_Info.

Parameters:
value_ptr -- pointer to SRM_SRF_Parameters_Info whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_SRF_Parameters_Info is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidSRFParametersInfoCode SRM_SRF_Parameters_Info_Code  value  ) 
 

Checks if the given value is a valid SRM_SRF_Parameters_Info_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFReferenceSurfaceInfo const SRM_SRF_Reference_Surface_Info value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_SRF_Reference_Surface_Info.

Parameters:
value_ptr -- pointer to SRM_SRF_Reference_Surface_Info whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_SRF_Reference_Surface_Info is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidSRFSCode SRM_SRFS_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSCodeInfo const SRM_SRFS_Code_Info value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_SRFS_Code_Info.

Parameters:
value_ptr -- pointer to SRM_SRFS_Code_Info whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_SRFS_Code_Info is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidSRFSInfo const SRM_SRFS_Info value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_SRFS_Info.

Parameters:
value_ptr -- pointer to SRM_SRFS_Info whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_SRFS_Info is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMAlabamaSPCSCode SRM_SRFSM_Alabama_SPCS_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_Alabama_SPCS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMJapanRectangularPlaneCSCode SRM_SRFSM_Japan_Rectangular_Plane_CS_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_Japan_Rectangular_Plane_CS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMLambertNTFCode SRM_SRFSM_Lambert_NTF_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_Lambert_NTF_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMUPSCode SRM_SRFSM_UPS_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_UPS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMUTMCode SRM_SRFSM_UTM_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_UTM_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFSMWisconsinSPCSCode SRM_SRFSM_Wisconsin_SPCS_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFSM_Wisconsin_SPCS_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFTCode SRM_SRFT_Code  value  ) 
 

Checks if the given value is a valid SRM_SRFT_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidSRFTParameters const SRM_SRFT_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_SRFT_Parameters.

Parameters:
value_ptr -- pointer to SRM_SRFT_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_SRFT_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.

EXPORT_DLL SRM_Boolean SRM_ValidStatusCode SRM_Status_Code  value  ) 
 

Checks if the given value is a valid SRM_Status_Code.

Parameters:
value -- value to be checked
Returns:
SRM_TRUE - if value is valid

SRM_FALSE - otherwise

EXPORT_DLL SRM_Boolean SRM_ValidTMParameters const SRM_TM_Parameters value_ptr,
SRM_Boolean  print_error,
SRM_Integer_Unsigned error_count_ptr
 

Checks the information in the given SRM_TM_Parameters.

Parameters:
value_ptr -- pointer to SRM_TM_Parameters whose contents are to be checked.
print_error -- whether to print error messages.
error_count_ptr -- pointer to a variable in which the error count for this SRM_TM_Parameters is stored; if NULL, no counting is performed.
Returns:
SRM_TRUE - if value_ptr is non-NULL and *value_ptr contains valid information.

SRM_FALSE - otherwise.


C API Version: 4.1.1 - 14 Jun 2007
Copyright © 2007 SEDRIS Docs by Doxygen 1.3.2