SRM

Class SRF_Celestiomagnetic

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_3D

SRM.SRF_Celestiomagnetic

All Implemented Interfaces:

Cloneable

public class SRF_Celestiomagnetic
extends BaseSRF_3D

SRF_Celestiomagnetic class declaration.

Author:

David Shen

See Also:

BaseSRF_3D

Field Summary

Fields inherited from class SRM.BaseSRF_3D

_component_is_angular, _component_valid_region

Fields inherited from class SRM.BaseSRF

_internalSRFs, _myCsCode, _myOpSeq, _mySrftCode, _orm, _rt

Constructor Summary

Constructors

Constructor and Description
SRF_Celestiomagnetic(SRM_ORM_Code orm, SRM_RT_Code rt) SRF_Celestiomagnetic only constructor by ORM code and RT code

Method Summary

Methods

Modifier and Type	Method and Description
Coord3D	createCoordinate3D() Create specific 3D coordinate for SRF_Celestiomagnetic with [ Double.NaN, Double.NaN, Double.NaN ]
Coord3D	createCoordinate3D(double coord_comp1, double coord_comp2, double coord_comp3) Create specific 3D coordinate for SRF_Celestiomagnetic with input values
boolean	isEqual(BaseSRF srf) Returns TRUE if the SRF parameters are equal
String	toString() Returns a String with the parameter values

Methods inherited from class SRM.BaseSRF_3D

calculateEuclideanDistance, changeCoordinate3DArraySRF, changeCoordinate3DArraySRFObject, changeCoordinate3DSRF, changeCoordinate3DSRFObject, changeDirectionArraySRF, changeDirectionArraySRFObject, changeDirectionSRF, changeDirectionSRFObject, checkDirection, comp_ori_mat, compLTP, computeSRFOrientation, createDirection, createDirection, createLococentricEuclidean3DSRF, getCoordinate3DValues, getDirectionValues, getExtendedValidRegion, getLocalTangentFrameSRFParameters, getMemberCode, getNaturalSRFSetMember, getNaturalSRFSetMemberCode, getValidRegion, setExtendedValidRegion, setValidRegion, transformOrientation, transformOrientationCommonOrigin, transformVector, transformVectorCommonOrigin, transformVectorInBodyFrame, transformVectorInBodyFrameCommonOrigin

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, makeClone, querySRFTSupport, setSrfCode, setSrfSetCode, setSrfSetMemberCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SRF_Celestiomagnetic

public SRF_Celestiomagnetic(SRM_ORM_Code orm,
                    SRM_RT_Code rt)
                     throws SrmException

SRF_Celestiomagnetic only constructor by ORM code and RT code

Throws:

SrmException

Method Detail

createCoordinate3D

public Coord3D createCoordinate3D()

Create specific 3D coordinate for SRF_Celestiomagnetic with [ Double.NaN, Double.NaN, Double.NaN ]

Specified by:

createCoordinate3D in class BaseSRF_3D

Returns:

a 3D coordinate object

createCoordinate3D

public Coord3D createCoordinate3D(double coord_comp1,
                         double coord_comp2,
                         double coord_comp3)

Create specific 3D coordinate for SRF_Celestiomagnetic with input values

Specified by:

createCoordinate3D in class BaseSRF_3D

Parameters:

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

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

coord_comp3 - in: the values of the third component of the 3D coordinate

Returns:

a 3D coordinate object

isEqual

public boolean isEqual(BaseSRF srf)

Returns TRUE if the SRF parameters are equal

Specified by:

isEqual in class BaseSRF

Returns:

TRUE if the SRF parameters are equal.

toString

public String toString()

Returns a String with the parameter values

Overrides:

toString in class BaseSRF