BaseSRF (Spatial Reference Model 4.4.0 API)

java.lang.Object
- SRM.BaseSRF

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BaseSRF_2D, BaseSRF_3D
```
public abstract class BaseSRF
extends Object
implements Cloneable
```
The BaseSRF abstract class is the base class for all SRFs.

Author:

David Shen

See Also:
BaseSRF_2D, BaseSRF_3D

Field Summary

Fields
Modifier and Type	Field and Description
`protected HashMap<String,BaseSRF>`	`_internalSRFs`
`protected SRM_CS_Code`	`_myCsCode`
`protected CacheManager`	`_myOpSeq`
`protected SRM_SRFT_Code`	`_mySrftCode`
`protected SRM_ORM_Code`	`_orm`
`protected SRM_RT_Code`	`_rt`

Constructor Summary

Constructors
Constructor and Description

BaseSRF()

Constructors
Constructor and Description
`BaseSRF()`

Method Summary

Methods
Modifier and Type	Method and Description
`static double`	`calculateEuclideanDistance(Coord coord1, Coord coord2)` Returns the Euclidean distance between two coordinates.
`SRM_Coordinate_Valid_Region_Code`	`changeCoordinateSRF(Coord src, Coord tgt)` Changes a coordinate's values to this SRF.
`SRM_Coordinate_Valid_Region_Code`	`checkCoordinate(Coord src)` Check a coordinate in this SRF for valid region.
`static BaseSRF`	`createSRFSetMember(SRM_SRFS_Code srf_set, SRM_SRFSM_Code set_member, SRM_ORM_Code orm, SRM_RT_Code rt)` Creates an SRF from a SRF set code, a set member code specific to that set, and an ORM code.
`static BaseSRF`	`createStandardSRF(SRM_SRF_Code srf_code, SRM_RT_Code rt_code)` Creates a Standard SRF from its SRF code.
`SRM_ORM_Code`	`get_orm()` Deprecated. As of SRM 4.1.2, replaced by getOrm()
`SRM_RT_Code`	`get_rt()` Deprecated. As of SRM 4.1.2, replaced by getRt()
`double`	`getA()` Returns this SRF's major semi-axis value (A).
`SRM_CS_Code`	`getCSCode()` Returns this SRF's CS Code.
`double`	`getF()` Returns this SRF's flattening value (F).
`static String`	`getImplVerInfo()` Returns the string for this version of SRM Java implementation.
`SRM_ORM_Code`	`getOrm()` Returns this SRF's Object Reference Model code.
`SRM_RT_Code`	`getRt()` Returns this SRF's RT code.
`SRM_SRF_Code`	`getSRFCode()` Returns this pre-defined ("standard") SRF code.
`SRM_SRFS_Code`	`getSRFSetCode()` Returns this SRF's Set code.
`SRM_SRFSM_Code`	`getSRFSetMemberCode()` Returns this SRF's Set member code.
`SRM_SRFT_Code`	`getSRFTemplateCode()` Returns this SRF's Template code.
`protected static double[]`	`interimConv(Coord src_coord, SRM_SRFT_Code tgt_srft)`
`abstract boolean`	`isEqual(BaseSRF srf)`
`BaseSRF`	`makeClone()` Returns the shallow copy of this object instance.
`static boolean`	`querySRFTSupport(SRM_SRFT_Code srft_code)` Queries for the SRFT support by the implementation.
`protected void`	`setSrfCode(SRM_SRF_Code srfCode)`
`protected void`	`setSrfSetCode(SRM_SRFS_Code srfSetCode)`
`protected void`	`setSrfSetMemberCode(SRM_SRFSM_Code srfSetMemberCode)`
`String`	`toString()` Returns a string representation of this SRF.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _orm
```
protected SRM_ORM_Code _orm
```
  - _rt
```
protected SRM_RT_Code _rt
```
  - _mySrftCode
```
protected SRM_SRFT_Code _mySrftCode
```
  - _myCsCode
```
protected SRM_CS_Code _myCsCode
```
  - _myOpSeq
```
protected CacheManager _myOpSeq
```
  - _internalSRFs
```
protected HashMap<String,BaseSRF> _internalSRFs
```
- Constructor Detail
  - BaseSRF
```
public BaseSRF()
```
- Method Detail
  - createStandardSRF
```
public static BaseSRF createStandardSRF(SRM_SRF_Code srf_code,
                        SRM_RT_Code rt_code)
                                 throws SrmException
```
    Creates a Standard SRF from its SRF code.
    
    Parameters:
    srf_code - in: the code for a standard SRF to create
    rt_code - in: the RT code to use in the created SRF
    
    Returns:
    a SRF template instance associated with the "Standard" SRF.
    
    Throws:
    
    This - method throws SrmException
    
    SrmException
    See Also:
    createStandardSRF(), SRM_SRF_Code A sample code to create a British National Grid Airy SRF is as follows:
  - createSRFSetMember
```
public static BaseSRF createSRFSetMember(SRM_SRFS_Code srf_set,
                         SRM_SRFSM_Code set_member,
                         SRM_ORM_Code orm,
                         SRM_RT_Code rt)
                                  throws SrmException
```
    Creates an SRF from a SRF set code, a set member code specific to that set, and an ORM code.
    
    Parameters:
    srf_set - in: the code for an SRF set
    set_member - in: the code for an SRF set member.
    orm - in: the ORM code associated with the created SRF
    rt - in: the RT transformation associated with the created SRF
    
    Returns:
    a SRF template instance associated with the SRF Set member.
    
    Throws:
    
    SrmException
    See Also:
    createSRFSetMember(), SRM_SRFS_Code, SRM_SSM_Code A sample code to create a UTM SRF corresponding to Zone 12 Southern hemisphere based on WGS 1984 with Identity transformation is as follows:
  - getSRFCode
```
public SRM_SRF_Code getSRFCode()
```
    Returns this pre-defined ("standard") SRF code.
    
    Returns:
    the pre-defined SRF code of this SRF
    See Also:
    createStandardSRF()
  - getSRFTemplateCode
```
public SRM_SRFT_Code getSRFTemplateCode()
```
    Returns this SRF's Template code.
    
    Returns:
    the SRF Template code of this SRF
    See Also:
    createStandardSRF()
  - getSRFSetCode
```
public SRM_SRFS_Code getSRFSetCode()
```
    Returns this SRF's Set code.
    
    Returns:
    the SRF Set code of this SRF
    See Also:
    createSRFSetMember()
  - getSRFSetMemberCode
```
public SRM_SRFSM_Code getSRFSetMemberCode()
```
    Returns this SRF's Set member code.
    
    Returns:
    the SRF Set member code of this SRF
    See Also:
    createSRFSetMember()
  - getCSCode
```
public SRM_CS_Code getCSCode()
```
    Returns this SRF's CS Code.
    
    Returns:
    the SRF CS code of this SRF
  - get_orm
```
public SRM_ORM_Code get_orm()
```
    Deprecated. As of SRM 4.1.2, replaced by getOrm()
    
    Returns this SRF's Object Reference Model code.
    
    Returns:
    an ORM code of this SRF
    See Also:
    getOrm()
  - getOrm
```
public SRM_ORM_Code getOrm()
```
    Returns this SRF's Object Reference Model code.
    
    Returns:
    an ORM code of this SRF
  - get_rt
```
public SRM_RT_Code get_rt()
```
    Deprecated. As of SRM 4.1.2, replaced by getRt()
    
    Returns this SRF's RT code.
    
    Returns:
    an RT code of this SRF
    See Also:
    getRt()
  - getRt
```
public SRM_RT_Code getRt()
```
    Returns this SRF's RT code.
    
    Returns:
    an RT code of this SRF
  - getA
```
public double getA()
```
    Returns this SRF's major semi-axis value (A).
    
    Returns:
    a major semi-axis value
  - getF
```
public double getF()
```
    Returns this SRF's flattening value (F).
    
    Returns:
    a flattening value
  - querySRFTSupport
```
public static boolean querySRFTSupport(SRM_SRFT_Code srft_code)
```
    Queries for the SRFT support by the implementation.
    
    Returns:
    true if the SRFT is supported by this implementation.
  - changeCoordinateSRF
```
public SRM_Coordinate_Valid_Region_Code changeCoordinateSRF(Coord src,
                                                   Coord tgt)
                                                     throws SrmException
```
    Changes a coordinate's values to this SRF.
    
    Parameters:
    src - in: the source coordinate in some other SRF
    tgt - in out: the target coordinate in this SRF
    
    Returns:
    the Valid Region of the target coordinate
    
    Throws:
    
    SrmException
  - checkCoordinate
```
public SRM_Coordinate_Valid_Region_Code checkCoordinate(Coord src)
                                                 throws SrmException
```
    Check a coordinate in this SRF for valid region.
    
    Parameters:
    src - in: the source coordinate in some other SRF
    
    Returns:
    the coordinate valid region code in the coordinate's SRF
    
    Throws:
    
    SrmException
  - calculateEuclideanDistance
```
public static double calculateEuclideanDistance(Coord coord1,
                                Coord 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 coordinates (in meters).
    
    Throws:
    
    SrmException
  - getImplVerInfo
```
public static String getImplVerInfo()
```
    Returns the string for this version of SRM Java implementation.
    
    Returns:
    This SRM Java implementation version.
  - toString
```
public String toString()
```
    Returns a string representation of this SRF.
    
    Overrides:
    
    toString in class Object
  - isEqual
```
public abstract boolean isEqual(BaseSRF srf)
```
    Returns:
    TRUE if the SRF parameters are equal.
  - makeClone
```
public BaseSRF makeClone()
                  throws SrmException
```
    Returns the shallow copy of this object instance.
    
    Throws:
    
    SrmException
  - setSrfCode
```
protected void setSrfCode(SRM_SRF_Code srfCode)
```
  - setSrfSetCode
```
protected void setSrfSetCode(SRM_SRFS_Code srfSetCode)
```
  - setSrfSetMemberCode
```
protected void setSrfSetMemberCode(SRM_SRFSM_Code srfSetMemberCode)
```
  - interimConv
```
protected static double[] interimConv(Coord src_coord,
                   SRM_SRFT_Code tgt_srft)
                               throws SrmException
```
    Throws:
    
    SrmException

Class BaseSRF

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_orm

_rt

_mySrftCode

_myCsCode

_myOpSeq

_internalSRFs

Constructor Detail

BaseSRF

Method Detail

createStandardSRF

createSRFSetMember

getSRFCode

getSRFTemplateCode

getSRFSetCode

getSRFSetMemberCode

getCSCode

get_orm

getOrm

get_rt

getRt

getA

getF

querySRFTSupport

changeCoordinateSRF

checkCoordinate

calculateEuclideanDistance

getImplVerInfo

toString

isEqual

makeClone

setSrfCode

setSrfSetCode

setSrfSetMemberCode

interimConv