IModel (Demo 2.0 API)

All Known Implementing Classes:

ModelAdapter, ModelFromLas, ModelFromShapefile, ModelFromText, UnitSquareModel
```
public interface IModel
```
Defines methods for accessing and maintaining a collection of sample points (a "model" of a surface).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addConstraints(File constraintsFile, List<IConstraint> constraints)` Adds constraints to the model
`boolean`	`areConstraintsLoaded()` Indicates if the constraint source for the model has been loaded
`boolean`	`areVerticesLoaded()` Indicates if the vertex source for the model has been loaded
`void`	`geo2xy(double latitude, double longitude, double[] xy)` If defined, converts a pair of geographic (latitude,longitude) coordinates to a pair of scaled Cartesian coordinates.
`double`	`getArea()` Gets the overall area of the model, in the units squared associated with the horizontal coordinate system.
`List<IConstraint>`	`getConstraints()` Gets the current list of constraints for the model/
`ICoordinateTransform`	`getCoordinateTransform()` Gets the coordinate transform associated with the model.
`String`	`getDescription()` Gets a shortdescription of the model
`File`	`getFile()` Gets the file associated with the model
`String`	`getFormattedCoordinates(double x, double y)` Get a string representation for the specified model coordinates.
`String`	`getFormattedX(double x)` Get a string representation of the specified model X coordinate.
`String`	`getFormattedY(double y)` Get a string representation of the specified model X coordinate.
`LinearUnits`	`getLinearUnits()` Gets the linear units for the coordinate system used by the data.
`double`	`getMaxX()` Gets the maximum x coordinate in the sample
`double`	`getMaxY()` Gets the maximum y coordinate in the sample
`double`	`getMaxZ()` Gets the maximum z coordinate in the sample
`double`	`getMinX()` Gets the minimum x coordinate in the sample
`double`	`getMinY()` Gets the minimum y coordinate in the sample
`double`	`getMinZ()` Gets the minimum z coordinate in the sample
`String`	`getName()` Get the name or identification associated with the model.
`double`	`getNominalPointSpacing()` Gets the estimated nominal point spacing for the model
`List<Vertex>`	`getPerimeterVertices()` Gets a list of the vertices that lie on the perimeter of the TIN.
`double`	`getReferenceReductionFactor()` Gets the reduction factor for the reference TIN
`IIncrementalTin`	`getReferenceTin()` Gets the "reference" TIN that was created when the data was first loaded.
`long`	`getTimeToLoadInMillis()` Gets the time required to load the model, in milliseconds.
`long`	`getTimeToSortInMillis()` Gets the time required to perform the post-loading Hilbert sort on the vertices, in milliseconds.
`int`	`getVertexCount()` Get the number of samples in the model
`Vertex`	`getVertexForIndex(int index)` Get the vertex with the specified vertex index.
`List<Vertex>`	`getVertexList()` Gets the list of vertices currently stored in the model; for efficiency purposes, this is simply a reference to internal storage and not a safe copy.
`boolean`	`hasConstraints()` Indicates whether the model has constraints and is thus a Constrained Delaunay Triangulation (CDT).
`boolean`	`hasConstraintsSource()` Indicates that the model has a definition for a constraint source.
`boolean`	`hasVertexSource()` Indicates that the model has a definition for a vertex source.
`boolean`	`isCoordinateSystemGeographic()` Indicates whether the coordinates used by this instance are geographic in nature.
`boolean`	`isLoaded()` Indicates whether the content of the model was already loaded.
`void`	`load(IMonitorWithCancellation monitor)` Load the metadata and data associated with the file for this model and compile a list of vertices for access by the application.
`void`	`xy2geo(double x, double y, double[] geo)` If defined, converts a pair of scaled Cartesian coordinates to a latitude and longitude.

- Method Detail
  - getVertexCount
```
int getVertexCount()
```
    Get the number of samples in the model
    
    Returns:
    
    a positive integer.
  - getMaxX
```
double getMaxX()
```
    Gets the maximum x coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getMinX
```
double getMinX()
```
    Gets the minimum x coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getMaxY
```
double getMaxY()
```
    Gets the maximum y coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getMinY
```
double getMinY()
```
    Gets the minimum y coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getMaxZ
```
double getMaxZ()
```
    Gets the maximum z coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getMinZ
```
double getMinZ()
```
    Gets the minimum z coordinate in the sample
    
    Returns:
    
    a valid floating point value
  - getNominalPointSpacing
```
double getNominalPointSpacing()
```
    Gets the estimated nominal point spacing for the model
    
    Returns:
    
    a positive value in the units associated with the horizontal coordinate system.
  - getArea
```
double getArea()
```
    Gets the overall area of the model, in the units squared associated with the horizontal coordinate system.
    
    Returns:
    
    a positive real value
  - load
```
void load(IMonitorWithCancellation monitor)
   throws IOException
```
    Load the metadata and data associated with the file for this model and compile a list of vertices for access by the application.
    
    Parameters:
    
    monitor - an optional monitor for tracking progress (null if not used)
    
    Throws:
    
    IOException - If a non-recoverable IO condition is encountered when reading the source file.
  - getFile
```
File getFile()
```
    Gets the file associated with the model
    
    Returns:
    
    a valid file
  - getName
```
String getName()
```
    Get the name or identification associated with the model. For file-based models, this value is usually the name (not path) of the file.
    
    Returns:
    
    a valid, potentially empty string.
  - getDescription
```
String getDescription()
```
    Gets a shortdescription of the model
    
    Returns:
    
    a valid string.
  - getVertexList
```
List<Vertex> getVertexList()
```
    Gets the list of vertices currently stored in the model; for efficiency purposes, this is simply a reference to internal storage and not a safe copy.
    
    Returns:
    
    a valid list (empty if not properly loaded)
  - getFormattedCoordinates
```
String getFormattedCoordinates(double x,
                               double y)
```
    Get a string representation for the specified model coordinates. Some models may include special information about formatting coordinates (such as those that implement geographic coordinates).
    
    Parameters:
    
    x - the x coordinate in the model coordinate system
    
    y - the y coordinate in the model coordinate system
    
    Returns:
    
    a valid string (content left to the implementation).
  - getFormattedX
```
String getFormattedX(double x)
```
    Get a string representation of the specified model X coordinate. Some models may include special information about formatting coordinates based on their magnitude or if they represent geographic coordinates.
    
    Parameters:
    
    x - the x coordinate in the model coordinate system.
    
    Returns:
    
    a valid string (content left to the implementation)/
  - getFormattedY
```
String getFormattedY(double y)
```
    Get a string representation of the specified model X coordinate. Some models may include special information about formatting coordinates based on their magnitude or if they represent geographic coordinates.
    
    Parameters:
    
    y - the y coordinate in the model coordinate system.
    
    Returns:
    
    a valid string (content left to the implementation)/
  - isLoaded
```
boolean isLoaded()
```
    Indicates whether the content of the model was already loaded. Typically this call is used for file-based models to indicate that data was read from disk.
    
    Returns:
    
    true if the model is loaded, otherwise false.
  - getReferenceTin
```
IIncrementalTin getReferenceTin()
```
    Gets the "reference" TIN that was created when the data was first loaded. It is expected that application code will access this TIN on a read-only basis and will not modify it. They are, however, allowed to replace it when a more detailed TIN becomes available.
    
    Returns:
    
    a valid TIN to be accessed on a read-only basis.
  - getReferenceReductionFactor
```
double getReferenceReductionFactor()
```
    Gets the reduction factor for the reference TIN
    
    Returns:
    
    a positive value; the large the value the larger the reduction.
  - getTimeToLoadInMillis
```
long getTimeToLoadInMillis()
```
    Gets the time required to load the model, in milliseconds. This value is used to format performance reports.
    
    Returns:
    
    a positive long integer.
  - getTimeToSortInMillis
```
long getTimeToSortInMillis()
```
    Gets the time required to perform the post-loading Hilbert sort on the vertices, in milliseconds. This value is used to format performance reports.
    
    Returns:
    
    a positive long integer.
  - getPerimeterVertices
```
List<Vertex> getPerimeterVertices()
```
    Gets a list of the vertices that lie on the perimeter of the TIN. The perimeter should be a convex polygon.
    
    Returns:
    
    a list of vertices.
  - getLinearUnits
```
LinearUnits getLinearUnits()
```
    Gets the linear units for the coordinate system used by the data. It is assumed that the vertical and horizontal coordinate systems will be in the same unit system, though assumption could change in a future implementation.
    
    Returns:
    
    a valid enumeration instance
  - isCoordinateSystemGeographic
```
boolean isCoordinateSystemGeographic()
```
    Indicates whether the coordinates used by this instance are geographic in nature.
    
    Returns:
    
    true if coordinates are geographic; otherwise, false.
  - getVertexForIndex
```
Vertex getVertexForIndex(int index)
```
    Get the vertex with the specified vertex index.
    
    Parameters:
    
    index - an arbitrary integer.
    
    Returns:
    
    if matched, a valid vertex; otherwise, a null;
  - xy2geo
```
void xy2geo(double x,
            double y,
            double[] geo)
```
    If defined, converts a pair of scaled Cartesian coordinates to a latitude and longitude. If undefined, no operation is performed.
    
    Parameters:
    
    x - a valid scaled Cartesian coordinate
    
    y - a valid scaled Cartesian coordinate
    
    geo - an array of dimension two to store the results (where geo[0]=latitude, geo[1]=longitude)
  - geo2xy
```
void geo2xy(double latitude,
            double longitude,
            double[] xy)
```
    If defined, converts a pair of geographic (latitude,longitude) coordinates to a pair of scaled Cartesian coordinates. If undefined, no operation is performed.
    
    Parameters:
    
    latitude - the latitude
    
    longitude - the longitude
    
    xy - a array of dimension two to store the results.
  - hasConstraints
```
boolean hasConstraints()
```
    Indicates whether the model has constraints and is thus a Constrained Delaunay Triangulation (CDT).
    
    Returns:
    
    true if the model has constraints.
  - addConstraints
```
void addConstraints(File constraintsFile,
                    List<IConstraint> constraints)
```
    Adds constraints to the model
    
    Parameters:
    
    constraintsFile - if the constraints were derived from a file, a valid reference; otherwise, a null
    
    constraints - a valid list of constraints.
  - getConstraints
```
List<IConstraint> getConstraints()
```
    Gets the current list of constraints for the model/
    
    Returns:
    
    a valid, potentially empty list.
  - hasVertexSource
```
boolean hasVertexSource()
```
    Indicates that the model has a definition for a vertex source. At this time, all implementations define this value as true, though that is subject to change in the future. A model that has a vertex source might not yet have a valid list of vertices if the data from the source has not yet been loaded
    
    Returns:
    
    true if the model has a source of vertices; otherwise false.
  - areVerticesLoaded
```
boolean areVerticesLoaded()
```
    Indicates if the vertex source for the model has been loaded
    
    Returns:
    
    true if the vertices for the model have been loaded; otherwise, false.
  - hasConstraintsSource
```
boolean hasConstraintsSource()
```
    Indicates that the model has a definition for a constraint source. At this time, all implementations define this value as true, though that is subject to change in the future. A model that has a constraint source might not yet have a valid list of constraints if the data from the source has not yet been loaded
    
    Returns:
    
    true if the model has a source of vertices; otherwise false.
  - areConstraintsLoaded
```
boolean areConstraintsLoaded()
```
    Indicates if the constraint source for the model has been loaded
    
    Returns:
    
    true if the vertices for the model have been loaded; otherwise, false.
  - getCoordinateTransform
```
ICoordinateTransform getCoordinateTransform()
```
    Gets the coordinate transform associated with the model. If no transform is set, this method will return a null
    
    Returns:
    
    if set, a valid transform; otherwise, a null.

Interface IModel

Method Summary

Method Detail

getVertexCount

getMaxX

getMinX

getMaxY

getMinY

getMaxZ

getMinZ

getNominalPointSpacing

getArea

load

getFile

getName

getDescription

getVertexList

getFormattedCoordinates

getFormattedX

getFormattedY

isLoaded

getReferenceTin

getReferenceReductionFactor

getTimeToLoadInMillis

getTimeToSortInMillis

getPerimeterVertices

getLinearUnits

isCoordinateSystemGeographic

getVertexForIndex

xy2geo

geo2xy

hasConstraints

addConstraints

getConstraints

hasVertexSource

areVerticesLoaded

hasConstraintsSource

areConstraintsLoaded

getCoordinateTransform