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

srm_BaseSRF3D.h File Reference

#include "srm.h"

Go to the source code of this file.

Defines

#define EXPORT_DLL

Typedefs

typedef SRM_Status_Code SRM_ChangeCoordinate3DSRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *source_coordinate, SRM_Coordinate3D *target_coordinate, SRM_Coordinate_Valid_Region *region)
typedef SRM_Status_Code SRM_ChangeCoordinate3DSRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *source_coordinate, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Coordinate3D *target_coordinate, SRM_Coordinate_Valid_Region *region)
typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D_Array *source_coordinate_array, SRM_Coordinate3D_Array *target_coordinate_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *region_array)
typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D_Array *source_coordinate_array, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Coordinate3D_Array *target_coordinate_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *region_array)
typedef SRM_Status_Code SRM_ChangeDirectionSRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction *source_direction, SRM_Direction *target_direction, SRM_Coordinate_Valid_Region *ref_coord_region)
typedef SRM_Status_Code SRM_ChangeDirectionSRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction *source_direction, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Direction *target_direction, SRM_Coordinate_Valid_Region *ref_coord_region)
typedef SRM_Status_Code SRM_ChangeDirectionArraySRF (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction_Array *source_direction_array, SRM_Direction_Array *target_direction_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *ref_coord_region_array)
typedef SRM_Status_Code SRM_ChangeDirectionArraySRFObject (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction_Array *source_direction_array, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Direction_Array *target_direction_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *ref_coord_region_array)
typedef SRM_Status_Code SRM_CreateCoordinate3D (SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Long_Float third_coordinate_component, SRM_Coordinate3D *new_coordinate)
typedef SRM_Status_Code SRM_CreateDirection (SRM_Object_Reference this_object, const SRM_Coordinate3D *reference_coordinate, SRM_Long_Float first_direction_component, SRM_Long_Float second_direction_component, SRM_Long_Float third_direction_component, SRM_Direction *new_direction)
typedef SRM_Status_Code SRM_ComputeSRFOrientation (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference out_ori)
typedef _SRM_LococentricEuclidean3D SRM_LococentricEuclidean3D
typedef SRM_Status_Code SRM_CreateLococentricEuclidean3DSRF (SRM_Object_Reference this_object, const SRM_Coordinate3D *lococentre, const SRM_Direction *primary_axis, const SRM_Direction *secondary_axis, SRM_LococentricEuclidean3D *new_lce3d_srf)
typedef SRM_Status_Code SRM_TransformOrientation (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference tgt_ori)
typedef SRM_Status_Code SRM_TransformOrientationCommonOrigin (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference tgt_ori, SRM_Coordinate_Valid_Region *ref_coord_region)
typedef SRM_Status_Code SRM_TransformVectorInBodyFrame (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Vector_3D *vec, const SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec)
typedef SRM_Status_Code SRM_TransformVectorInBodyFrameCommonOrigin (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Vector_3D *vec, SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec, SRM_Coordinate_Valid_Region *ref_coord_region)
typedef SRM_Status_Code SRM_TransformVector (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Vector_3D *src_vec, const SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec)
typedef SRM_Status_Code SRM_TransformVectorCommonOrigin (SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Vector_3D *src_vec, SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec, SRM_Coordinate_Valid_Region *ref_coord_region)
typedef SRM_Status_Code SRM_DestroyCoordinate3D (SRM_Object_Reference this_object, SRM_Object_Reference coordinate)
typedef SRM_Status_Code SRM_DestroyDirection (SRM_Object_Reference this_object, SRM_Object_Reference direction)
typedef SRM_Status_Code SRM_EuclideanDistance3D (SRM_Object_Reference this_object, const SRM_Coordinate3D *point1_coordinate, const SRM_Coordinate3D *point2_coordinate, SRM_Long_Float *distance)
typedef SRM_Status_Code SRM_GetCoordinate3DValues (SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component, SRM_Long_Float *third_coordinate_component)
typedef SRM_Status_Code SRM_GetDirectionValues (SRM_Object_Reference this_object, const SRM_Direction *direction, SRM_Coordinate3D *reference_coordinate, SRM_Long_Float *first_direction_component, SRM_Long_Float *second_direction_component, SRM_Long_Float *third_direction_component)
typedef SRM_Status_Code SRM_GetExtendedValidRegion (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_GetValidRegion (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_GetNaturalSRFSMemberCode (SRM_Object_Reference this_object, const SRM_Coordinate3D *source_coordinate, SRM_ORM_Code orm_code, SRM_RT_Code rt_code, SRM_SRFS_Code target_srfs, SRM_SRFS_Code_Info *srfs_code_info)
typedef SRM_Status_Code SRM_SetCoordinate3DValues (SRM_Object_Reference this_object, SRM_Coordinate3D *coordinate, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Long_Float third_coordinate_component)
typedef SRM_Status_Code SRM_SetExtendedValidRegion (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_SetValidRegion (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 83 of file srm_BaseSRF3D.h.

Typedef Documentation

typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D_Array *source_coordinate_array, SRM_Coordinate3D_Array *target_coordinate_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *region_array )
 

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.

Parameters:
this_object in: this SRF object
source_srf in: this is the surface SRF
source_coordinate_array in: the array of source coordinates in some other SRF
target_coordinate out: the array of destination coordinate in this SRF
index out: the number of elements in the arrays
region_array out: the valid regions associated with the destination coordinate
Returns:
a status code

Definition at line 154 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate3DArraySRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D_Array *source_coordinate_array, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Coordinate3D_Array *target_coordinate_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *region_array )
 

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.

Parameters:
this_object in: this SRF object
source_srf in: the array of source SRF
h_st in: ORM 3D transformation
target_coordinate_array out: the array of destination coordinate in this SRF
index out: the number of elements in the arrays
region_array out: the valid regions associated with the destination coordinate
Returns:
a status code

Definition at line 176 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate3DSRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *source_coordinate, SRM_Coordinate3D *target_coordinate, SRM_Coordinate_Valid_Region *region )
 

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: this source SRF
source_coordinate in: this is the source coordinate
target_coordinate out: this is the target coordinate
region out: valid region for target coordinate
Returns:
a status code

Definition at line 110 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeCoordinate3DSRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *source_coordinate, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Coordinate3D *target_coordinate, SRM_Coordinate_Valid_Region *region )
 

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_1, omega_2 and omega_3 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: this source SRF
source_coordinate in: the source coordinate in some other SRF
h_st in: ORM 3D transformation
target_coordinate out: the destination coordinate in this SRF
region out: valid region for destination coordinate
Returns:
a status code

Definition at line 131 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeDirectionArraySRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction_Array *source_direction_array, SRM_Direction_Array *target_direction_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *ref_coord_region_array )
 

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

Note:
The destination direction must have been created using this SRF.
Parameters:
this_object in: this SRF object
source_srf in: this source SRF
source_direction_array in: the array of source direction in some other SRF
target_direction_array out: the array of destination direction in this SRF
index out: the number of elements in the arrays
ref_coord_region_array out: reference coordinate region array
Returns:
a status code

Definition at line 237 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeDirectionArraySRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction_Array *source_direction_array, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Direction_Array *target_direction_array, SRM_Integer_Positive *index, SRM_Coordinate_Valid_Region_Array *ref_coord_region_array )
 

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

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

The value of omega_1, omega_2 and omega_3 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: this source SRF
source_direction_array in: the source direction in some other SRF
h_st in: ORM 3D transformation
target_direction out: the destination direction in this SRF
index out: the number of elements in the arrays
ref_coord_region out: reference coordinate region array
Returns:
a status code

Definition at line 260 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeDirectionSRF( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction *source_direction, SRM_Direction *target_direction, SRM_Coordinate_Valid_Region *ref_coord_region )
 

Changes a direction's values to this SRF.

Note:
The destination direction must have been created using this SRF.
Parameters:
this_object in: this SRF object
source_srf in: this source SRF
source_direction in: the source direction in some other SRF
target_direction out: the destination direction in this SRF
ref_coord_region out: reference coordinate region
Returns:
a status code

Definition at line 196 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ChangeDirectionSRFObject( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Direction *source_direction, const SRM_ORM_Transformation_3D_Parameters *h_st, SRM_Direction *target_direction, SRM_Coordinate_Valid_Region *ref_coord_region )
 

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

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

The value of omega_1, omega_2 and omega_3 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: this source SRF
source_direction in: the source direction in some other SRF
h_st in: ORM 3D transformation
target_direction out: the destination direction in this SRF
ref_coord_region out: reference coordinate region
Returns:
a status code

Definition at line 217 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_ComputeSRFOrientation( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference out_ori )
 

This method sets the values of the Orientation object representing the orientation of the source srf (at the source reference location) with respect to this (the target) srf (at the target reference location). The Orientation is computed as the cosine matrix of the source local tangent frame (at the source referece location) with respect to the target local tangent frame (at the target reference location).

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

The output orientation (out_ori) points to the one of the concrete Orientation class previously created.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_point in : the source reference point
tgt_ref_point in : the target reference point
out_ori out : the orientation whose values are set by this method
Returns:
a status code

Definition at line 325 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_CreateCoordinate3D( SRM_Object_Reference this_object, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Long_Float third_coordinate_component, SRM_Coordinate3D *new_coordinate )
 

Creates a 3D coordinate object.

Parameters:
this_object in: this SRF object
first_coordinate_component in: creates the first of the three components
second_coordinate_component in: creates the second of the three components
third_coordinate_component in: creates the third of the three components
new_coordinate out: new coordinate
Returns:
a status code

Definition at line 279 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_CreateDirection( SRM_Object_Reference this_object, const SRM_Coordinate3D *reference_coordinate, SRM_Long_Float first_direction_component, SRM_Long_Float second_direction_component, SRM_Long_Float third_direction_component, SRM_Direction *new_direction )
 

Creates a Direction object.

Parameters:
this_object in: this SRF object
reference_coordinate in: this is the surface coordinate
first_direction_component in: creates first direction component
second_direction_component in: creates second direction component
third_direction_component in: creates third direction component
new_direction out: results the new direction
Returns:
a status code

Definition at line 298 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_CreateLococentricEuclidean3DSRF( SRM_Object_Reference this_object, const SRM_Coordinate3D *lococentre, const SRM_Direction *primary_axis, const SRM_Direction *secondary_axis, SRM_LococentricEuclidean3D *new_lce3d_srf )
 

creates a Loccentric Euclidean 3D SRF whose origin in at the input lococentre and the primary and secodary axes are aligned with the input direction axes.

Parameters:
this_object in : the invoking SRF
lococentre in : the lococentre of the SRF
primary_axis in : the direction of the primary axis
secondary_axis in : the direction of the secondary axis
new_lce3d_srf out : an instance of Lococentric Euclidean 3D SRF.
Returns:
a status code

Definition at line 348 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_DestroyCoordinate3D( SRM_Object_Reference this_object, SRM_Object_Reference coordinate )
 

Destroys the 3D Coordinate

Parameters:
this_object in: this SRF object
coordinate in: the 3D coordinate to be destroyed

Definition at line 573 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_DestroyDirection( SRM_Object_Reference this_object, SRM_Object_Reference direction )
 

Destroys direction

Parameters:
this_object in: this SRF object
direction in: the direction to be destroyed

Definition at line 584 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_EuclideanDistance3D( SRM_Object_Reference this_object, const SRM_Coordinate3D *point1_coordinate, const SRM_Coordinate3D *point2_coordinate, SRM_Long_Float *distance )
 

Euclidean Distance 3D

Parameters:
this_object in: this SRF object
point1_coordinate in: this is the surface coordinate
point2_coordinate in: this is the target coordinate
distance out: distance between the two coordinates
Returns:
a status code

Definition at line 598 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_GetCoordinate3DValues( SRM_Object_Reference this_object, const SRM_Coordinate3D *coordinate, SRM_Long_Float *first_coordinate_component, SRM_Long_Float *second_coordinate_component, SRM_Long_Float *third_coordinate_component )
 

Retrieves the 3D coordinate component values.

Parameters:
this_object in: this SRF object
coordinate in: gets the 3D coordinate
first_coordinate_component out: gets the first 3D coordinate
second_coordinate_component out: gets the second 3D coordinate
third_coordinate_component out: gets the third 3D coordinate
Returns:
a status code

Definition at line 614 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_GetDirectionValues( SRM_Object_Reference this_object, const SRM_Direction *direction, SRM_Coordinate3D *reference_coordinate, SRM_Long_Float *first_direction_component, SRM_Long_Float *second_direction_component, SRM_Long_Float *third_direction_component )
 

Retrieves the direction component values.

Parameters:
this_object in: this SRF object
direction in: gets direction
reference_coordinate out: results the reference coordinate
first_direction_component out: first direction component
second_direction_component out: second direction component
third_direction_component out: third direction component
Returns:
a status code

Definition at line 633 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_GetExtendedValidRegion( 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 )
 

Get 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.
Parameters:
this_object in: this SRF object
component_identifier in: identifies the component
interval_type out: the type of interval
extended_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 658 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_GetNaturalSRFSMemberCode( SRM_Object_Reference this_object, const SRM_Coordinate3D *source_coordinate, SRM_ORM_Code orm_code, SRM_RT_Code rt_code, SRM_SRFS_Code target_srfs, SRM_SRFS_Code_Info *srfs_code_info )
 

Get the Natural Set Member Code

Parameters:
this_object in: this SRF object
source_coordinate in: this is the source coordinate
orm_code in: orm code
rt_code in: rt code
target_srfs in: this outputs the correct target srfs
srfs_code_info out: results in set member
Returns:
a status code

Definition at line 700 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_GetValidRegion( 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 Region for this SRF.

Note:
Given a coordinate component, the last invocation of this method or the setExtendedValidRegion method determines the valid and extended valid intervals of the coordinate component values.
Parameters:
this_object in: this SRF object
component_identifier in: identifies the component
interval_type out: the type of 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 682 of file srm_BaseSRF3D.h.

typedef struct _SRM_LococentricEuclidean3D SRM_LococentricEuclidean3D
 

Definition at line 335 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_SetCoordinate3DValues( SRM_Object_Reference this_object, SRM_Coordinate3D *coordinate, SRM_Long_Float first_coordinate_component, SRM_Long_Float second_coordinate_component, SRM_Long_Float third_coordinate_component )
 

Sets the 3D coordinate component values.

Parameters:
this_object in: this SRF object
coordinate in out: sets the 3D coordinate
first_coordinate_component in: sets the first 3D coordinate
second_coordinate_component in: sets the second 3D coordinate
third_coordinate_component in: sets the third 3D coordinate
Returns:
a status code

Definition at line 718 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_SetExtendedValidRegion( 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: identifies the component
interval_type out: the type of interval
extended_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 747 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_SetValidRegion( 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.

Note:
Given a coordinate component, the last invocation of this method or the setExtendedValidRegion 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.

Parameters:
this_object in: this SRF object
component_identifier in: identifies the component
interval_type out: the type of 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 774 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformOrientation( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference tgt_ori )
 

Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output orientation is computed by composing the orientation of LTF_S with respect to LTF_T with the input source orientation. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

The output orientation (out_ori) points to the one of the concrete Orientation class previously created.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_ori in : the source orientation of some linear reference frame with respect to LTF_S
tgt_ref_loc in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located
tgt_ori out : the target orientation with respect to LTF_T
Returns:
a status code

Definition at line 381 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformOrientationCommonOrigin( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, SRM_Coordinate3D *tgt_ref_loc, SRM_Object_Reference tgt_ori, SRM_Coordinate_Valid_Region *ref_coord_region )
 

Given an orientation with respect to a local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the orientation with respect to the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output orientation is computed by composing the orientation of LTF_S with respect to LTF_T with the input source orientation. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

The output orientation (out_ori) points to the one of the concrete Orientation class previously created.

The ref_coord_region output parameter could be set to NULL if no region information is needed.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_ori in : the source orientation of some linear reference frame with respect to LTF_S
tgt_ref_loc out : the coordinate of the common reference location in the target SRF
tgt_ori out : the target orientation with respect to LTF_T
ref_coord_region out : the valid region category for the target reference location
Returns:
a status code

Definition at line 419 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformVector( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Vector_3D *src_vec, const SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec )
 

Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output vector is computed by applying the orientation of LTF_S with respect to LTF_T to the source vector. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_vec in : the source vector in LTF_S
tgt_ref_loc in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located
tgt_vec out : the target vector in LTF_T
Returns:
a status code

Definition at line 527 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformVectorCommonOrigin( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Vector_3D *src_vec, SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec, SRM_Coordinate_Valid_Region *ref_coord_region )
 

Given a vector in the local tangent frame (LTF_S) associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output vector is computed by applying the orientation of LTF_S with respect to LTF_T to the source vector. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_vec in : the source vector in LTF_S
tgt_ref_loc out : coordinate of the common reference location in the target SRF
tgt_vec out : the target vector in LTF_T
ref_coord_region out : the valid region category for the target reference location
Returns:
a status code

Definition at line 557 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformVectorInBodyFrame( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Vector_3D *vec, const SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec )
 

Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. The output vector is computed by applying the composed orientation, from the orientation of LTF_S with respect to LTF_T with the source orientation, to the source vector. This method is equivalent to applying the orientation result from the transformOrientation method to the source vector. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_ori in : the source orientation of some linear reference frame L with respect to LTF_S
input_vec in : the input vector in L
tgt_ref_loc in : the target reference location (a coordinate in this SRF, the target SRF) where the origin of the target local tangent frame (LTF_T) is located
tgt_vec out : the target vector in LTF_T
Returns:
a status code

Definition at line 457 of file srm_BaseSRF3D.h.

typedef SRM_Status_Code SRM_TransformVectorInBodyFrameCommonOrigin( SRM_Object_Reference this_object, const SRM_Object_Reference source_srf, const SRM_Coordinate3D *src_ref_loc, const SRM_Object_Reference src_ori, const SRM_Vector_3D *vec, SRM_Coordinate3D *tgt_ref_loc, SRM_Vector_3D *tgt_vec, SRM_Coordinate_Valid_Region *ref_coord_region )
 

Given a vector in a body frame (or in general any linear reference frame) whose orientation with respect to the local tangent frame (LTF_S) that is associated with a reference location in the source SRF, this method computes the vector in the local tangent frame (LTF_T) associated with the specified reference location in the target SRF. LTF_S and LTF_T have a common origin. The output vector is computed by applying the composed orientation, from the orientation of LTF_S with respect to LTF_T with the source orientation, to the source vector. This method is equivalent to applying the orientation result from the transformOrientation method to the source vector. The SRF invoking this method is the target SRF.

Note:
The target reference location must have been created using this SRF.

The source reference location must have been created using the source SRF.

Parameters:
this_object in : the target SRF
source_srf in : the source SRF
src_ref_loc in : the source reference location (a coordinate in the source SRF) where the origin of the source local tangent frame (LTF_S) is located
src_ori in : the source orientation of some linear reference frame L with respect to LTF_S
input_vec in : the input vector in L
tgt_ref_loc out : the coordinate of the common reference location in the target SRF
tgt_vec out : the target vector in LTF_T
ref_coord_region out : the valid region category for the target reference location
Returns:
a status code

Definition at line 495 of file srm_BaseSRF3D.h.

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