SRM

Class BaseSRF_2D

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_2D

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SRF_LocalSpaceAzimuthal, SRF_LocalSpacePolar, SRF_LocalSpaceRectangular2D

public abstract class BaseSRF_2D
extends BaseSRF

The BaseSRF_2D abstract class is the base class for the 2D SRFs.

Author:

David Shen

See Also:

BaseSRF, BaseSRF_3D

Field Summary

Fields inherited from class SRM.BaseSRF

_internalSRFs, _myCsCode, _myOpSeq, _mySrftCode, _orm, _rt

Constructor Summary

Constructors

Constructor and Description
BaseSRF_2D()

Method Summary

Methods

Modifier and Type	Method and Description
static double	calculateEuclideanDistance(Coord2D coord1, Coord2D coord2) Returns the Euclidean distance between two coordinates.
int	changeCoordinate2DArraySRF(Coord2D[] src, Coord2D[] tgt) Changes a array of 2D coordinates to this SRF.
int	changeCoordinate2DArraySRFObject(Coord2D[] src, SRM_ORM_Trans_2D_Params hst, Coord2D[] tgt) Changes an array of 2D coordinates to this SRF using tranformation object.
void	changeCoordinate2DSRF(Coord2D src, Coord2D tgt) Changes a coordinate's values to this SRF.
void	changeCoordinate2DSRFObject(Coord2D src, SRM_ORM_Trans_2D_Params hst, Coord2D tgt) Changes a coordinate's values to this SRF using tranformation object.
abstract Coord2D	createCoordinate2D() Creates a 2D coordinate object.
abstract Coord2D	createCoordinate2D(double coord_comp1, double coord_comp2) Creates a 2D coordinate object.
double[]	getCoordinate2DValues(Coord2D coord) Retrieves the 2D coordinate component values.

Methods inherited from class SRM.BaseSRF

calculateEuclideanDistance, changeCoordinateSRF, checkCoordinate, createSRFSetMember, createStandardSRF, get_orm, get_rt, getA, getCSCode, getF, getImplVerInfo, getOrm, getRt, getSRFCode, getSRFSetCode, getSRFSetMemberCode, getSRFTemplateCode, interimConv, isEqual, makeClone, querySRFTSupport, setSrfCode, setSrfSetCode, setSrfSetMemberCode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseSRF_2D

public BaseSRF_2D()

Method Detail

createCoordinate2D

public abstract Coord2D createCoordinate2D()

Creates a 2D coordinate object.

Returns:

a 2D coordinate object

createCoordinate2D

public abstract Coord2D createCoordinate2D(double coord_comp1,
                         double coord_comp2)

Creates a 2D coordinate object.

Parameters:

coord_comp1 - in: the values of the first component of the 2D coordinate

coord_comp2 - in: the values of the second component of the 2D coordinate

Returns:

a 2D coordinate object

getCoordinate2DValues

public double[] getCoordinate2DValues(Coord2D coord)
                               throws SrmException

Retrieves the 2D coordinate component values.

Parameters:

coord - in: a 2D coordinate, which must have been created using this SRF

Returns:

an array of size 2 containing the component values for the 2D coordinate

Throws:

SrmException

changeCoordinate2DSRF

public void changeCoordinate2DSRF(Coord2D src,
                         Coord2D tgt)
                           throws SrmException

Changes a coordinate's values to this SRF.

Parameters:

src - in: the source coordinate in some other 2D SRF

tgt - out: the target coordinate in this 2D SRF

Throws:

SrmException

changeCoordinate2DArraySRF

public int changeCoordinate2DArraySRF(Coord2D[] src,
                             Coord2D[] tgt)
                               throws SrmException

Changes a array of 2D coordinates to this SRF.

Parameters:

src - in: the array of source 3D coordinate in some other 3D SRF

tgt - out: the array of target coordinate in this 3D SRF

Returns:

the index of the offending coordinate in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

Throws:

SrmException

changeCoordinate2DSRFObject

public void changeCoordinate2DSRFObject(Coord2D src,
                               SRM_ORM_Trans_2D_Params hst,
                               Coord2D tgt)
                                 throws SrmException

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

Parameters:

src - in: the source coordinate in some other 2D SRF

hst - in: the ORM 2D transformation

tgt - out: the target coordinate in this 2D SRF

Throws:

SrmException

changeCoordinate2DArraySRFObject

public int changeCoordinate2DArraySRFObject(Coord2D[] src,
                                   SRM_ORM_Trans_2D_Params hst,
                                   Coord2D[] tgt)
                                     throws SrmException

Changes an array of 2D coordinates to this SRF using tranformation object.

Parameters:

src - in: the array of source 3D coordinate in some other 3D SRF

hst - in: the ORM 2D transformation

tgt - out: the array of target coordinate in this 3D SRF

Returns:

the index of the offending coordinate in the source array when an error condition occurs. Otherwise, it is the size of the source array plus one.

Throws:

SrmException

calculateEuclideanDistance

public static double calculateEuclideanDistance(Coord2D coord1,
                                Coord2D coord2)
                                         throws SrmException

Returns the Euclidean distance between two coordinates.

Parameters:

coord1 - in: a coordinate in some SRF

coord2 - in: a coordinate in some SRF

Returns:

the Euclidean distance between the two Coord2D coordinates (in metres).

Throws:

SrmException