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

srm_BaseSRF2D.h File Reference

#include "srm.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_ChangeCoordinate2DArraySRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D_Array *source_coordinate_array, SRM_Coordinate2D_Array *target_coordinate_array, SRM_Integer_Positive *index)
typedef SRM_Status_Code SRM_ChangeCoordinate2DArraySRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D_Array *source_coordinate_array, const SRM_ORM_Transformation_2D_Parameters *h_st, SRM_Coordinate2D_Array *target_coordinate_array, SRM_Integer_Positive *index)
typedef SRM_Status_Code SRM_ChangeCoordinate2DSRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D *source_coordinate, SRM_Coordinate2D *target_coordinate)
typedef SRM_Status_Code SRM_ChangeCoordinate2DSRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D *source_coordinate, const SRM_ORM_Transformation_2D_Parameters *h_st, SRM_Coordinate2D *target_coordinate)
typedef SRM_Status_Code SRM_CreateCoordinate2D (SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Coordinate2D *new_coordinate)
typedef SRM_Status_Code SRM_DestroyCoordinate2D (SRM_Object_Reference this_object, SRM_Object_Reference coordinate)
typedef SRM_Status_Code SRM_EuclideanDistance2D (SRM_Object_Reference this_object, const SRM_Coordinate2D *source_coordinate, const SRM_Coordinate2D *target_coordinate, SRM_Long_Float *distance)
typedef SRM_Status_Code SRM_GetCoordinate2DValues (SRM_Object_Reference this_object, const SRM_Coordinate2D *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component)

Define Documentation

#define EXPORT_DLL
 

Definition at line 19 of file srm_BaseSRF2D.h.

Typedef Documentation

typedef SRM_Status_Code SRM_ChangeCoordinate2DArraySRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D_Array *source_coordinate_array, SRM_Coordinate2D_Array *target_coordinate_array, SRM_Integer_Positive *index )
 

Changes an array of coordinate values to this SRF.

Note:
The destination coordinates must have been created using this SRF.

The source and destination arrays must be of same size.

All the coordinates in an array must be associated with the same SRF.

When an exception is raised, the index will be set to the offending coordinate.

Parameters:
this_object in: this SRF object
source_srf in: source SRF
source_coordinate_array out: the array of source coordinates in some other SRF
target_coordinate_array out: the array of destination coordinate in this SRF
index in: the number of elements in the arrays
Returns:
a status code

Definition at line 49 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate2DArraySRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D_Array *source_coordinate_array, const SRM_ORM_Transformation_2D_Parameters *h_st, SRM_Coordinate2D_Array *target_coordinate_array, SRM_Integer_Positive *index )
 

Changes an array of coordinate values to this SRF using tranformation object.

Note:
The destination coordinates must have been created using this SRF.

The source and destination arrays must be of same size.

All the coordinates in an array must be associated with the same SRF.

When an exception is raised, the index will be set to the offending coordinate.

Parameters:
this_object in: this SRF object
source_srf in: source SRF
source_coordinate_array in: the array of source coordinates in some other SRF.
h_st in: 2D ORM four parameter transformation
target_coordinate_array out: the array of destination coordinate in this SRF.
index out: the number of elements in the arrays
Returns:
a status code

Definition at line 72 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate2DSRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D *source_coordinate, SRM_Coordinate2D *target_coordinate )
 

Changes a coordinate's values to this SRF.

Note:
The destination coordinate must have been created using this SRF.
Parameters:
this_object in: this SRF object.
source_srf in: source SRF.
source_coordinate in: the source coordinate in some other SRF.
target_coordinate out: the destination coordinate in this SRF
Returns:
a status code

Definition at line 90 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate2DSRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate2D *source_coordinate, const SRM_ORM_Transformation_2D_Parameters *h_st, SRM_Coordinate2D *target_coordinate )
 

Changes a coordinate's values to this SRF using tranformation object.

Note:
The destination coordinate must have been created using this SRF.

The value of omega for hst must be within the range ( -2_PI, 2_PI ).

The value of delta_s for hst must be stricly greater than -1.0.

Parameters:
this_object in: this SRF object.
source_srf in: source SRF.
surface_coordinate in: the source coordinate in some other SRF
h_st in: 2D ORM transformation
target_coordinate out: the destination coordinate in this SRF
Returns:
a status code

Definition at line 109 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_CreateCoordinate2D( SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Coordinate2D *new_coordinate )
 

Creates a 2D coordinate object.

See also:
freeCoordinate2D()
Parameters:
this_object in: this SRF object
first_coordinate_component in: first component
second_coordinate_component in: second component
new_coordinate out: new coordinate
Returns:
a status code

Definition at line 126 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_DestroyCoordinate2D( SRM_Object_Reference this_object, SRM_Object_Reference coordinate )
 

Destroys the 2D Coordinate

Parameters:
this_object in: this SRF object
coordinate in: destroy this coordinate

Definition at line 138 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_EuclideanDistance2D( SRM_Object_Reference this_object, const SRM_Coordinate2D *source_coordinate, const SRM_Coordinate2D *target_coordinate, SRM_Long_Float *distance )
 

Euclidean Distance 2D

Parameters:
this_object in: this SRF object
surface_coordinate in: this is the surface coordinate
target_coordinate in: this is the target coordinate
distance out: outputs the distance
Returns:
a status code

Definition at line 151 of file srm_BaseSRF2D.h.

typedef SRM_Status_Code SRM_GetCoordinate2DValues( SRM_Object_Reference this_object, const SRM_Coordinate2D *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component )
 

Retrieves the 2D coordinate component values.

Parameters:
this_object in: this SRF object
coordinate in: 2D coordinate
first_coordinate_component out: first coordinate
second_coordinate_component out: second coordinate
Returns:
a status code

Definition at line 166 of file srm_BaseSRF2D.h.

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