SRM

Class SRF_LocalTangentSpaceCylindrical

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_3D

SRM.BaseSRF_WithTangentPlaneSurface

SRM.SRF_LocalTangentSpaceCylindrical

All Implemented Interfaces:

Cloneable

public class SRF_LocalTangentSpaceCylindrical
extends BaseSRF_WithTangentPlaneSurface

SRF_LocalTangentSpaceCylindrical class declaration.

Author:

David Shen

See Also:

BaseSRF_WithTangentPlaneSurface

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_LocalTangentSpaceCylindrical(SRM_ORM_Code orm, SRM_RT_Code rt, double geodetic_longitude, double geodetic_latitude, double azimuth, double height_offset) Constructor by individual SRF parameters
SRF_LocalTangentSpaceCylindrical(SRM_ORM_Code orm, SRM_RT_Code rt, SRF_LT_Params params) Constructor by SRF parameter object

Method Summary

Methods

Modifier and Type	Method and Description
Coord3D	createCoordinate3D() Create specific 3D coordinate for SRF_LocalTangentSpaceCylindrical with [ Double.NaN, Double.NaN, Double.NaN ]
Coord3D	createCoordinate3D(double coord_comp1, double coord_comp2, double coord_comp3) Create specific 3D coordinate for SRF_LocalTangentSpaceCylindrical with input values
CoordSurf	createSurfaceCoordinate() Create specific Surface coordinate for SRF_LocalTangentSpaceCylindrical with [ Double.NaN, Double.NaN ]
CoordSurf	createSurfaceCoordinate(double coord_comp1, double coord_comp2) Create specific Surface coordinate for SRF_LocalTangentSpaceCylindrical with input values
double	get_azimuth() Returns the azimuth SRF parameter value
double	get_geodetic_latitude() Returns the geodetic_latitude SRF parameter value
double	get_geodetic_longitude() Returns the geodetic_longitude SRF parameter value
double	get_height_offset() Returns the height_offset SRF parameter value
CoordSurf	getAssociatedSurfaceCoordinate(Coord3D coord) Returns a surface coordinate associated with a 3D coordinate for SRF_LocalTangentSpaceCylindrical
Coord3D	getPromotedSurfaceCoordinate(CoordSurf surf_coord) Returns a 3D coordinate representing the same location as specified by a surface coordinate for SRF_LocalTangentSpaceCylindrical
SRF_LT_Params	getSRFParameters() Returns the SRF parameter object
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_WithTangentPlaneSurface

getSurfaceCoordinateValues

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_LocalTangentSpaceCylindrical

public SRF_LocalTangentSpaceCylindrical(SRM_ORM_Code orm,
                                SRM_RT_Code rt,
                                SRF_LT_Params params)
                                 throws SrmException

Constructor by SRF parameter object

Throws:

SrmException

SRF_LocalTangentSpaceCylindrical

public SRF_LocalTangentSpaceCylindrical(SRM_ORM_Code orm,
                                SRM_RT_Code rt,
                                double geodetic_longitude,
                                double geodetic_latitude,
                                double azimuth,
                                double height_offset)
                                 throws SrmException

Constructor by individual SRF parameters

Throws:

SrmException

Method Detail

createCoordinate3D

public Coord3D createCoordinate3D()

Create specific 3D coordinate for SRF_LocalTangentSpaceCylindrical 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_LocalTangentSpaceCylindrical 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

createSurfaceCoordinate

public CoordSurf createSurfaceCoordinate()

Create specific Surface coordinate for SRF_LocalTangentSpaceCylindrical with [ Double.NaN, Double.NaN ]

Specified by:

createSurfaceCoordinate in class BaseSRF_WithTangentPlaneSurface

Returns:

a surface coordinate object

createSurfaceCoordinate

public CoordSurf createSurfaceCoordinate(double coord_comp1,
                                double coord_comp2)

Create specific Surface coordinate for SRF_LocalTangentSpaceCylindrical with input values

Specified by:

createSurfaceCoordinate in class BaseSRF_WithTangentPlaneSurface

Parameters:

coord_comp1 - in: the values of the first component of the surface coordinate

coord_comp2 - in: the values of the second component of the surface coordinate

Returns:

a surface coordinate object

getSRFParameters

public SRF_LT_Params getSRFParameters()

Returns the SRF parameter object

get_geodetic_longitude

public double get_geodetic_longitude()

Returns the geodetic_longitude SRF parameter value

get_geodetic_latitude

public double get_geodetic_latitude()

Returns the geodetic_latitude SRF parameter value

get_azimuth

public double get_azimuth()

Returns the azimuth SRF parameter value

get_height_offset

public double get_height_offset()

Returns the height_offset SRF parameter value

getAssociatedSurfaceCoordinate

public CoordSurf getAssociatedSurfaceCoordinate(Coord3D coord)
                                         throws SrmException

Returns a surface coordinate associated with a 3D coordinate for SRF_LocalTangentSpaceCylindrical

Specified by:

getAssociatedSurfaceCoordinate in class BaseSRF_WithTangentPlaneSurface

Parameters:

coord - in: a 3D coordinate in this SRF

Returns:

a surface coordinate object in this SRF

Throws:

SrmException

getPromotedSurfaceCoordinate

public Coord3D getPromotedSurfaceCoordinate(CoordSurf surf_coord)
                                     throws SrmException

Returns a 3D coordinate representing the same location as specified by a surface coordinate for SRF_LocalTangentSpaceCylindrical

Specified by:

getPromotedSurfaceCoordinate in class BaseSRF_WithTangentPlaneSurface

Parameters:

surf_coord - in: a surface coordinate in this SRF

Returns:

a 3D coordinate object in this SRF

Throws:

SrmException

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