TLcdGenericGeodeticDatumFactory (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.geodesy.TLcdGenericGeodeticDatumFactory

All Implemented Interfaces:

ILcdGeodeticDatumFactory, Serializable
```
public class TLcdGenericGeodeticDatumFactory
extends Object
implements ILcdGeodeticDatumFactory, Serializable
```
ILcdGeodeticDatumFactory implementation that creates TLcdGeodeticDatum objects based on the 7 (or 10) parameters that define the geodetic datum.
The properties read are:

Property name Default value

x 0

y 0

z 0

rotx 0

roty 0

rotz 0

scale 1.0

px 0.0

py 0.0

pz 0.0

name Geodetic datum

The geodetic datum is based on an ellipsoid, which is defined by two additional properties:

Property name Default value

a --

1overf --

The TLcdGeodeticDatum generated has WGS84 as a reference datum.

See Also:

TLcdGeodeticDatum, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ELLIPSOID_INVERSE_FLATTENING` The property key for the ellipsoid inverse flattening.
`static String`	`ELLIPSOID_NAME` The property key for the ellipsoid name.
`static String`	`ELLIPSOID_SEMI_MAJOR_AXIS` The property key for the ellipsoid semi major axis.
`static String`	`NAME` The property key for the geodetic datums name.
`static String`	`PIVOT_X` The property key for the geodetic datums x component of the `TLcdGeodeticDatum.setPivotX(double)`.
`static String`	`PIVOT_Y` The property key for the geodetic datums y component of the `TLcdGeodeticDatum.setPivotY(double)`.
`static String`	`PIVOT_Z` The property key for the geodetic datums z component of the `TLcdGeodeticDatum.setPivotZ(double)`.
`static String`	`PRIME_MERIDIAN` The property key for the geodetic datums prime meridian.
`static String`	`ROT_X` The property key for the geodetic datums rotation in x direction.
`static String`	`ROT_Y` The property key for the geodetic datums rotation in y direction.
`static String`	`ROT_Z` The property key for the geodetic datums rotation in z direction.
`static String`	`SCALE` The property key for the geodetic datums scale.
`static String`	`X` The property key for the geodetic datums translation in x direction.
`static String`	`Y` The property key for the geodetic datums translation in y direction.
`static String`	`Z` The property key for the geodetic datums translation in z direction.

Constructor Summary

Constructors
Constructor and Description

TLcdGenericGeodeticDatumFactory()

Constructors
Constructor and Description
`TLcdGenericGeodeticDatumFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canExportGeodeticDatum(ILcdGeodeticDatum aGeodeticDatum)` Returns whether the passed geodetic datum can be exported.
`ILcdGeodeticDatum`	`createGeodeticDatum(String aPrefix, Properties aProperties)` Creates a `TLcdGeodeticDatum` which has the WGS84 geodetic datum as reference datum and retrieves its parameters from the properties object.
`void`	`writePropertiesSFCT(ILcdGeodeticDatum aGeodeticDatum, String aPrefix, Properties aPropertiesSFCT)` If the geodetic datum passed is a `TLcdGeodeticDatum` instance with WGS84 as its reference datum, this method adds the parameters of the geodetic datum to the Properties object, so that the geodetic datum can be recreated with `createGeodeticDatum(java.lang.String, java.util.Properties)`.

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

- Field Detail
  - ELLIPSOID_SEMI_MAJOR_AXIS
```
public static final String ELLIPSOID_SEMI_MAJOR_AXIS
```
    The property key for the ellipsoid semi major axis.
    
    See Also:
    
    TLcdEllipsoid, Constant Field Values
  - ELLIPSOID_INVERSE_FLATTENING
```
public static final String ELLIPSOID_INVERSE_FLATTENING
```
    The property key for the ellipsoid inverse flattening.
    
    See Also:
    
    TLcdEllipsoid, Constant Field Values
  - ELLIPSOID_NAME
```
public static final String ELLIPSOID_NAME
```
    The property key for the ellipsoid name.
    
    See Also:
    
    TLcdEllipsoid, Constant Field Values
  - X
```
public static final String X
```
    The property key for the geodetic datums translation in x direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - Y
```
public static final String Y
```
    The property key for the geodetic datums translation in y direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - Z
```
public static final String Z
```
    The property key for the geodetic datums translation in z direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - ROT_X
```
public static final String ROT_X
```
    The property key for the geodetic datums rotation in x direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - ROT_Y
```
public static final String ROT_Y
```
    The property key for the geodetic datums rotation in y direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - ROT_Z
```
public static final String ROT_Z
```
    The property key for the geodetic datums rotation in z direction.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - SCALE
```
public static final String SCALE
```
    The property key for the geodetic datums scale.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - PIVOT_X
```
public static final String PIVOT_X
```
    The property key for the geodetic datums x component of the TLcdGeodeticDatum.setPivotX(double).
    
    Since:
    
    2023.1
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - PIVOT_Y
```
public static final String PIVOT_Y
```
    The property key for the geodetic datums y component of the TLcdGeodeticDatum.setPivotY(double).
    
    Since:
    
    2023.1
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - PIVOT_Z
```
public static final String PIVOT_Z
```
    The property key for the geodetic datums z component of the TLcdGeodeticDatum.setPivotZ(double).
    
    Since:
    
    2023.1
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - NAME
```
public static final String NAME
```
    The property key for the geodetic datums name.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
  - PRIME_MERIDIAN
```
public static final String PRIME_MERIDIAN
```
    The property key for the geodetic datums prime meridian.
    
    See Also:
    
    TLcdGeodeticDatum, Constant Field Values
- Constructor Detail
  - TLcdGenericGeodeticDatumFactory
```
public TLcdGenericGeodeticDatumFactory()
```
- Method Detail
  - createGeodeticDatum
```
public ILcdGeodeticDatum createGeodeticDatum(String aPrefix,
                                             Properties aProperties)
                                      throws IllegalArgumentException
```
    Creates a TLcdGeodeticDatum which has the WGS84 geodetic datum as reference datum and retrieves its parameters from the properties object.
    
    Specified by:
    
    createGeodeticDatum in interface ILcdGeodeticDatumFactory
    
    Parameters:
    
    aPrefix - the prefix to pre-pend to the properties to be read.
    
    aProperties - the Properties object to retrieve the geodetic datum from.
    
    Returns:
    
    a TLcdGeodeticDatum which has the WGS84 geodetic datum as reference datum and its parameters retrieved from the properties object.
    
    Throws:
    
    IllegalArgumentException - when a property which is expected as double could not be converted to a double.
  - writePropertiesSFCT
```
public void writePropertiesSFCT(ILcdGeodeticDatum aGeodeticDatum,
                                String aPrefix,
                                Properties aPropertiesSFCT)
```
    If the geodetic datum passed is a TLcdGeodeticDatum instance with WGS84 as its reference datum, this method adds the parameters of the geodetic datum to the Properties object, so that the geodetic datum can be recreated with createGeodeticDatum(java.lang.String, java.util.Properties).
    
    Parameters:
    
    aGeodeticDatum - the TLcdGeodeticDatum to add to the properties object.
    
    aPrefix - the prefix to pre-pend to the properties names.
    
    aPropertiesSFCT - the Properties object to modify.
    
    Throws:
    
    IllegalArgumentException - when an ILcdGeodeticDatum implementation other than TLcdGeodeticDatum is passed, or a TLcdGeodeticDatum with a reference datum different from WGS84.
  - canExportGeodeticDatum
```
public boolean canExportGeodeticDatum(ILcdGeodeticDatum aGeodeticDatum)
```
    Returns whether the passed geodetic datum can be exported.
    
    Parameters:
    
    aGeodeticDatum - the geodetic datum to check.
    
    Returns:
    
    true if the geodetic datum passed is a TLcdGeodeticDatum, with WGS84 as the reference datum.
    
    See Also:
    
    writePropertiesSFCT(com.luciad.geodesy.ILcdGeodeticDatum, java.lang.String, java.util.Properties)

Property name	Default value
x	0
y	0
z	0
rotx	0
roty	0
rotz	0
scale	1.0
px	0.0
py	0.0
pz	0.0
name	Geodetic datum

LuciadLightspeedClass TLcdGenericGeodeticDatumFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ELLIPSOID_SEMI_MAJOR_AXIS

ELLIPSOID_INVERSE_FLATTENING

ELLIPSOID_NAME

X

Y

Z

ROT_X

ROT_Y

ROT_Z

SCALE

PIVOT_X

PIVOT_Y

PIVOT_Z

NAME

PRIME_MERIDIAN

Constructor Detail

TLcdGenericGeodeticDatumFactory

Method Detail

createGeodeticDatum

writePropertiesSFCT

canExportGeodeticDatum