com.luciad.lucy.addons.modelreference

LuciadLightspeedClass TLcyGeodeticReference

java.lang.Object

com.luciad.reference.ALcdGeoReference

com.luciad.reference.TLcdGeodeticReference

com.luciad.lucy.addons.modelreference.TLcyGeodeticReference

All Implemented Interfaces:

ILcdExtendedModelReference, ILcdModelReference, ILcdGeodeticReference, ILcdGeoReference, ILcdCloneable, Serializable, Cloneable

public class TLcyGeodeticReference
extends TLcdGeodeticReference

Adds a property displayName and editable to its superclass. The editable property tells the model reference addon if this geodetic reference can be modified or not. The display name is used to present the geodetic reference to a user.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.reference.ILcdGeoReference

CARTESIAN, GEODETIC

Constructor Summary

Constructors

Constructor and Description
TLcyGeodeticReference() Creates a new TLcyGeodeticReference with a WGS84 geodetic datum.
TLcyGeodeticReference(ILcdGeodeticDatum aGeodeticDatum) Creates a new TLcyGeodeticReference with the given geodetic datum.
TLcyGeodeticReference(ILcdGeodeticDatum aGeodeticDatum, String aDisplayName, boolean aEditable) Creates a new TLcyGeodeticReference with the given geodetic datum, display name and editable value.
TLcyGeodeticReference(TLcyGeodeticReference aGeodeticReference) Copy constructor.

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes Object.clone() public.
boolean	equals(Object aObj)
int	getCoordinateType() Returns ILcdGeoReference.GEODETIC.
String	getDisplayName() Deprecated. Use #getName() instead.
ILcdGeodeticDatum	getGeodeticDatum() Returns the ILcdGeodeticDatum of this ILcdGeoReference.
String	getName()
int	hashCode()
boolean	isEditable() Returns true if this TLcyGeodeticReference can be edited, false otherwise.
void	loadProperties(String aPrefix, Properties aProperties) This method will, given aPrefix and aProperties, set its property geodeticDatum to an instance of ILcdGeodeticDatum.
ILcdPoint	makeModelPoint() Creates a model point that is compatible with this model reference.
void	setDisplayName(String aDisplayName) Deprecated. Use #setName(String) instead.
void	setEditable(boolean aEditable) Sets true if this TLcyGeodeticReference can be modified, false otherwise.
void	setGeodeticDatum(ILcdGeodeticDatum aGeodeticDatum) Sets the geodetic datum this reference is based on.
void	setName(String aName)
String	toString() Returns the name of the geodetic datum.
void	writePropertiesSFCT(String aPrefix, Properties aProperties) Stores the properties that define this model reference into the specified Properties object as a side effect.

Methods inherited from class com.luciad.reference.ALcdGeoReference

getModelReferenceMetadata, setModelReferenceMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TLcyGeodeticReference

public TLcyGeodeticReference()

Creates a new TLcyGeodeticReference with a WGS84 geodetic datum.

See Also:

TLcdGeodeticReference

TLcyGeodeticReference

public TLcyGeodeticReference(ILcdGeodeticDatum aGeodeticDatum)

Creates a new TLcyGeodeticReference with the given geodetic datum.

Parameters:

aGeodeticDatum - The geodetic datum to use for this geodetic reference.

See Also:

TLcdGeodeticReference

TLcyGeodeticReference

public TLcyGeodeticReference(ILcdGeodeticDatum aGeodeticDatum,
                             String aDisplayName,
                             boolean aEditable)

Creates a new TLcyGeodeticReference with the given geodetic datum, display name and editable value.

Parameters:

aGeodeticDatum - The geodetic datum to use for this TLcyGeodeticReference.

aDisplayName - The display name to present this TLcyGeodeticReference to a user.

aEditable - True if this geodetic reference can be modified, false otherwise.

See Also:

TLcdGeodeticReference

TLcyGeodeticReference

public TLcyGeodeticReference(TLcyGeodeticReference aGeodeticReference)

Copy constructor.

Parameters:

aGeodeticReference - The reference to copy.

See Also:

TLcdGeodeticReference

Method Detail

getDisplayName

@Deprecated
public String getDisplayName()

Deprecated. Use #getName() instead.

Returns the display name of this TLcyGeodeticReference using the method getName().

Returns:

the display name of this TLcyGeodeticReference.

See Also:

setDisplayName(java.lang.String)

setDisplayName

@Deprecated
public void setDisplayName(String aDisplayName)

Deprecated. Use #setName(String) instead.

Sets the display name of this TLcyGeodeticReference using the method setName(String).

Parameters:

aDisplayName - the display name of this TLcyGeodeticReference.

See Also:

getDisplayName()

isEditable

public boolean isEditable()

Returns true if this TLcyGeodeticReference can be edited, false otherwise.

Returns:

true if this TLcyGeodeticReference can be edited, false otherwise.

See Also:

setEditable(boolean)

setEditable

public void setEditable(boolean aEditable)

Sets true if this TLcyGeodeticReference can be modified, false otherwise.

Parameters:

aEditable - True if this TLcyGeodeticReference can be modified, false otherwise.

getGeodeticDatum

public ILcdGeodeticDatum getGeodeticDatum()

Description copied from interface: ILcdGeoReference

Returns the ILcdGeodeticDatum of this ILcdGeoReference.

Specified by:

getGeodeticDatum in interface ILcdGeoReference

Overrides:

getGeodeticDatum in class ALcdGeoReference

Returns:

the ILcdGeodeticDatum of this ILcdGeoReference.

See Also:

ILcdGeoReference.getGeodeticDatum(), ALcdGeoReference.setGeodeticDatum(com.luciad.geodesy.ILcdGeodeticDatum)

setGeodeticDatum

public void setGeodeticDatum(ILcdGeodeticDatum aGeodeticDatum)

Description copied from class: ALcdGeoReference

Sets the geodetic datum this reference is based on.

Overrides:

setGeodeticDatum in class ALcdGeoReference

Parameters:

aGeodeticDatum - the geodetic datum this reference is based on.

See Also:

ALcdGeoReference.getGeodeticDatum()

getName

public String getName()

Overrides:

getName in class ALcdGeoReference

setName

public void setName(String aName)

Overrides:

setName in class ALcdGeoReference

getCoordinateType

public int getCoordinateType()

Description copied from class: TLcdGeodeticReference

Returns ILcdGeoReference.GEODETIC.

Specified by:

getCoordinateType in interface ILcdGeoReference

Overrides:

getCoordinateType in class TLcdGeodeticReference

Returns:

ILcdGeoReference.GEODETIC.

makeModelPoint

public ILcdPoint makeModelPoint()

Description copied from interface: ILcdModelReference

Creates a model point that is compatible with this model reference. It is unspecified how (which coordinates) the point is initialized. Users should initialize the point correctly before inserting it into a model.

Specified by:

makeModelPoint in interface ILcdModelReference

Overrides:

makeModelPoint in class TLcdGeodeticReference

Returns:

a point that is compatible with this model reference.

loadProperties

public void loadProperties(String aPrefix,
                           Properties aProperties)
                    throws IllegalArgumentException

Description copied from class: TLcdGeodeticReference

This method will, given aPrefix and aProperties, set its property geodeticDatum to an instance of ILcdGeodeticDatum. To be able to set the property geodeticDatum the aProperties should contain entries which will be analyzed by the TLcdGeodeticDatumFactory. The keys of those entries should begin with '<aPrefix>TLcdGeodeticReference.geodeticDatum.'.

Specified by:

loadProperties in interface ILcdModelReference

Overrides:

loadProperties in class TLcdGeodeticReference

Parameters:

aPrefix - a common prefix for all property names that are read.

aProperties - the properties to be parsed.

Throws:

IllegalArgumentException - if the model reference cannot be constructed from the properties.

writePropertiesSFCT

public void writePropertiesSFCT(String aPrefix,
                                Properties aProperties)
                         throws IllegalArgumentException

Description copied from interface: ILcdModelReference

Stores the properties that define this model reference into the specified Properties object as a side effect. Each particular implementation of this interface can define which properties it stores.

Specified by:

writePropertiesSFCT in interface ILcdModelReference

Overrides:

writePropertiesSFCT in class TLcdGeodeticReference

Parameters:

aPrefix - a common prefix for all property names written.

aProperties - the properties that will contain the serialized properties for this model reference, as a side effect.

Throws:

IllegalArgumentException - if the model reference cannot be serialized into properties.

See Also:

TLcdGeodeticReference.loadProperties(java.lang.String, java.util.Properties)

equals

public boolean equals(Object aObj)

Overrides:

equals in class TLcdGeodeticReference

hashCode

public int hashCode()

Overrides:

hashCode in class ALcdGeoReference

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdGeodeticReference

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class ALcdGeoReference

See Also:

Object.clone()

toString

public String toString()

Description copied from class: TLcdGeodeticReference

Returns the name of the geodetic datum.

Overrides:

toString in class TLcdGeodeticReference

Returns:

the name of the geodetic datum.

See Also:

ALcdGeoReference.getName()