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

srm_struct_util.h File Reference

This file provides utility methods to translate the SRM structures used in DRM fields (SE_SRF_Info, SRM_Coordinate) into SRM handles used by the rest of the SRM C API (SRM_SRF, SRM_Coordinate) so that SRM C API methods may be used for conversions. More...

#include "srm_types.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Functions

EXPORT_DLL SRM_Status_Code SRM_CreateSRFFromSRFTemplateParams (const SRM_SRFT_Parameters *srft_params_in_ptr, SRM_RT_Code rt_code, SRM_Object_Reference *srf_out_ptr)
EXPORT_DLL SRM_Status_Code SRM_DestroySRF (SRM_Object_Reference srf_ptr)
EXPORT_DLL SRM_Status_Code SRM_CreateCoordinateFromCoordinateParams (SRM_Object_Reference srf, const SRM_Coordinate *coord_params_in_ptr, SRM_Object_Reference *coordinate_out_ptr)
EXPORT_DLL SRM_Status_Code SRM_DestroyCoordinate (SRM_Object_Reference coordinate_ptr)
EXPORT_DLL SRM_Status_Code SRM_GetCoordFromCoordinate (SRM_Object_Reference coordinate, SRM_Coordinate *coord_params_out_ptr)
EXPORT_DLL SRM_Status_Code SRM_SetCoordValues (SRM_Object_Reference coord_in_ptr, SRM_Long_Float oordinate1_in, SRM_Long_Float oordinate2_in, SRM_Long_Float oordinate3_in)
EXPORT_DLL SRM_Status_Code SRM_GetCoordValues (const SRM_Object_Reference coord_in_ptr, SRM_Long_Float *oordinate1_out_ptr, SRM_Long_Float *oordinate2_out_ptr, SRM_Long_Float *oordinate3_out_ptr)
EXPORT_DLL SRM_Boolean SRM_IsCoordAngular (const SRM_Object_Reference coord_in_ptr)
EXPORT_DLL SRM_Boolean SRM_IsCoord2D (const SRM_Object_Reference coord_in_ptr)
EXPORT_DLL SRM_Boolean SRM_IsCoordSurface (const SRM_Object_Reference coord_in_ptr)
EXPORT_DLL SRM_Boolean SRM_IsCoord3D (const SRM_Object_Reference coord_in_ptr)

Detailed Description

This file provides utility methods to translate the SRM structures used in DRM fields (SE_SRF_Info, SRM_Coordinate) into SRM handles used by the rest of the SRM C API (SRM_SRF, SRM_Coordinate) so that SRM C API methods may be used for conversions.

Author:
Greg Hull (SAIC), Kevin Wertman (SAIC)

Definition in file srm_struct_util.h.

Define Documentation

#define EXPORT_DLL
 

Definition at line 100 of file srm_struct_util.h.

Function Documentation

EXPORT_DLL SRM_Status_Code SRM_CreateCoordinateFromCoordinateParams (  SRM_Object_Reference  srf,
const SRM_Coordinate *  coord_params_in_ptr,
SRM_Object_Reference *  coordinate_out_ptr
) 
 

Creates a new Coordinate opaque handle based on the Coord structure being passed in.

EXPORT_DLL SRM_Status_Code SRM_CreateSRFFromSRFTemplateParams (  const SRM_SRFT_Parameters *  srft_params_in_ptr,
SRM_RT_Code  rt_code,
SRM_Object_Reference *  srf_out_ptr
) 
 

Creates a new SRF based on the SRF Template Parameters structure being passed in.

EXPORT_DLL SRM_Status_Code SRM_DestroyCoordinate (  SRM_Object_Reference  coordinate_ptr  ) 
 

Frees a Coordinate opaque handle created by the SRM_CreateCoordinateFromCoordinateParams() function.

EXPORT_DLL SRM_Status_Code SRM_DestroySRF (  SRM_Object_Reference  srf_ptr  ) 
 

Frees an SRF template instance created by the SRM_CreateSRFFromSRFTemplateParams() function.

EXPORT_DLL SRM_Status_Code SRM_GetCoordFromCoordinate (  SRM_Object_Reference  coordinate,
SRM_Coordinate *  coord_params_out_ptr
) 
 

Populates an SRM_Coordinate structure with the relevant information from the opaque SRM_Coordinate handle being passed in

EXPORT_DLL SRM_Status_Code SRM_GetCoordValues (  const SRM_Object_Reference  coord_in_ptr,
SRM_Long_Float *  oordinate1_out_ptr,
SRM_Long_Float *  oordinate2_out_ptr,
SRM_Long_Float *  oordinate3_out_ptr
) 
 

Generically gets the values of a coordinate. If the coordinate is not a 3D coordinate, the oordinate3_out_ptr argument will be ignored.

EXPORT_DLL SRM_Boolean SRM_IsCoord2D (  const SRM_Object_Reference  coord_in_ptr  ) 
 

Determines if the given SRM_Coordinate represents an 2D coordinate.

EXPORT_DLL SRM_Boolean SRM_IsCoord3D (  const SRM_Object_Reference  coord_in_ptr  ) 
 

Determines if the given SRM_Coordinate represents an 3D coordinate.

EXPORT_DLL SRM_Boolean SRM_IsCoordAngular (  const SRM_Object_Reference  coord_in_ptr  ) 
 

Determines if the given SRM_Coordinate represents an angular coordinate.

EXPORT_DLL SRM_Boolean SRM_IsCoordSurface (  const SRM_Object_Reference  coord_in_ptr  ) 
 

Determines if the given SRM_Coordinate represents an surface coordinate.

EXPORT_DLL SRM_Status_Code SRM_SetCoordValues (  SRM_Object_Reference  coord_in_ptr,
SRM_Long_Float  oordinate1_in,
SRM_Long_Float  oordinate2_in,
SRM_Long_Float  oordinate3_in
) 
 

Generically sets the values of a coordinate. If the coordinate is not a 3D coordinate, the oordinate3_in argument will be ignored.

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