Interface ILcdModelReference

All Superinterfaces:
Cloneable, ILcdCloneable, Serializable
All Known Subinterfaces:
ILcdExtendedModelReference
All Known Implementing Classes:
ALcdGeoReference, TLcdCartesianReference, TLcdDHDNGermanGridReference, TLcdGeocentricReference, TLcdGeodeticReference, TLcdGeoidReference, TLcdGridReference, TLcdLambert1972BelgiumGridReference, TLcdLambertFrenchGridReference, TLcdRD1918DutchGridReference, TLcdSwissGridReference, TLcdTopocentricReference, TLcdUPSGrid, TLcdUTMGrid, TLcdXYModelReference

public interface ILcdModelReference extends Serializable, ILcdCloneable
Root interface for all classes defining the coordinate system in which the geometry of elements in an ILcdModel is expressed.

Implementations should add enough information to fully and uniquely define the coordinate system they describe; for example, a geodetic reference may add information on what ellipsoid is used to model the earth.

Implementations of this interface should be immutable.

The points contained in a model may differ depending on the coordinate system (for example, a 2D coordinate system requires 2D points, while a 3D coordinate system requires 3D points). This interface provides the method makeModelPoint() to create valid model points for this coordinate system.

See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    loadProperties(String aPrefix, Properties aProperties)
    Initializes this model reference based on the information in the specified properties.
    Creates a model point that is compatible with this model reference.
    void
    writePropertiesSFCT(String aPrefix, Properties aPropertiesSFCT)
    Stores the properties that define this model reference into the specified Properties object as a side effect.

    Methods inherited from interface com.luciad.util.ILcdCloneable

    clone
  • Method Details

    • loadProperties

      void loadProperties(String aPrefix, Properties aProperties) throws IllegalArgumentException
      Initializes this model reference based on the information in the specified properties. Each particular implementation of this interface can define which properties it reads.

      This method should only be called once to initialize this model reference (model references should be immutable).

      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

      void writePropertiesSFCT(String aPrefix, Properties aPropertiesSFCT) throws IllegalArgumentException
      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.
      Parameters:
      aPrefix - a common prefix for all property names written.
      aPropertiesSFCT - 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.
    • makeModelPoint

      ILcdPoint makeModelPoint()
      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.
      Returns:
      a point that is compatible with this model reference.