org.tinfour.demo.viewer.backplane

Class UnitSquareModel

java.lang.Object

org.tinfour.demo.viewer.backplane.UnitSquareModel

All Implemented Interfaces:

IModel

public class UnitSquareModel
extends Object
implements IModel

Provides a simple model covering a unit square and containing a relatively small number of points. Intended as a development aid.

Constructor Summary

Constructors

Constructor and Description
UnitSquareModel(int count) Create an instance of the model with the specified number of points.

Method Summary

Modifier and Type	Method and Description
void	addConstraints(File constraintsFile, List<org.tinfour.common.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<org.tinfour.common.IConstraint>	getConstraints() Gets the current list of constraints for the model/
org.tinfour.utils.loaders.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.
org.tinfour.utils.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<org.tinfour.common.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
org.tinfour.common.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
org.tinfour.common.Vertex	getVertexForIndex(int index) Get the vertex with the specified vertex index.
List<org.tinfour.common.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(org.tinfour.common.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnitSquareModel

public UnitSquareModel(int count)

Create an instance of the model with the specified number of points.

Parameters:

count - an integer greater than 3.

Method Detail

getVertexCount

public int getVertexCount()

Description copied from interface: IModel

Get the number of samples in the model

Specified by:

getVertexCount in interface IModel

Returns:

a positive integer.

getMaxX

public double getMaxX()

Description copied from interface: IModel

Gets the maximum x coordinate in the sample

Specified by:

getMaxX in interface IModel

Returns:

a valid floating point value

getMinX

public double getMinX()

Description copied from interface: IModel

Gets the minimum x coordinate in the sample

Specified by:

getMinX in interface IModel

Returns:

a valid floating point value

getMaxY

public double getMaxY()

Description copied from interface: IModel

Gets the maximum y coordinate in the sample

Specified by:

getMaxY in interface IModel

Returns:

a valid floating point value

getMinY

public double getMinY()

Description copied from interface: IModel

Gets the minimum y coordinate in the sample

Specified by:

getMinY in interface IModel

Returns:

a valid floating point value

getMaxZ

public double getMaxZ()

Description copied from interface: IModel

Gets the maximum z coordinate in the sample

Specified by:

getMaxZ in interface IModel

Returns:

a valid floating point value

getMinZ

public double getMinZ()

Description copied from interface: IModel

Gets the minimum z coordinate in the sample

Specified by:

getMinZ in interface IModel

Returns:

a valid floating point value

getArea

public double getArea()

Description copied from interface: IModel

Gets the overall area of the model, in the units squared associated with the horizontal coordinate system.

Specified by:

getArea in interface IModel

Returns:

a positive real value

getNominalPointSpacing

public double getNominalPointSpacing()

Description copied from interface: IModel

Gets the estimated nominal point spacing for the model

Specified by:

getNominalPointSpacing in interface IModel

Returns:

a positive value in the units associated with the horizontal coordinate system.

load

public void load(org.tinfour.common.IMonitorWithCancellation monitor)
          throws IOException

Description copied from interface: IModel

Load the metadata and data associated with the file for this model and compile a list of vertices for access by the application.

Specified by:

load in interface IModel

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

public File getFile()

Description copied from interface: IModel

Gets the file associated with the model

Specified by:

getFile in interface IModel

Returns:

a valid file

getName

public String getName()

Description copied from interface: IModel

Get the name or identification associated with the model. For file-based models, this value is usually the name (not path) of the file.

Specified by:

getName in interface IModel

Returns:

a valid, potentially empty string.

getDescription

public String getDescription()

Description copied from interface: IModel

Gets a shortdescription of the model

Specified by:

getDescription in interface IModel

Returns:

a valid string.

getVertexList

public List<org.tinfour.common.Vertex> getVertexList()

Description copied from interface: IModel

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.

Specified by:

getVertexList in interface IModel

Returns:

a valid list (empty if not properly loaded)

getFormattedCoordinates

public String getFormattedCoordinates(double x,
                                      double y)

Description copied from interface: IModel

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).

Specified by:

getFormattedCoordinates in interface IModel

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

public String getFormattedX(double x)

Description copied from interface: IModel

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.

Specified by:

getFormattedX in interface IModel

Parameters:

x - the x coordinate in the model coordinate system.

Returns:

a valid string (content left to the implementation)/

getFormattedY

public String getFormattedY(double y)

Description copied from interface: IModel

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.

Specified by:

getFormattedY in interface IModel

Parameters:

y - the y coordinate in the model coordinate system.

Returns:

a valid string (content left to the implementation)/

isLoaded

public boolean isLoaded()

Description copied from interface: IModel

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.

Specified by:

isLoaded in interface IModel

Returns:

true if the model is loaded, otherwise false.

getReferenceTin

public org.tinfour.common.IIncrementalTin getReferenceTin()

Description copied from interface: IModel

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.

Specified by:

getReferenceTin in interface IModel

Returns:

a valid TIN to be accessed on a read-only basis.

getReferenceReductionFactor

public double getReferenceReductionFactor()

Description copied from interface: IModel

Gets the reduction factor for the reference TIN

Specified by:

getReferenceReductionFactor in interface IModel

Returns:

a positive value; the large the value the larger the reduction.

getTimeToLoadInMillis

public long getTimeToLoadInMillis()

Description copied from interface: IModel

Gets the time required to load the model, in milliseconds. This value is used to format performance reports.

Specified by:

getTimeToLoadInMillis in interface IModel

Returns:

a positive long integer.

getTimeToSortInMillis

public long getTimeToSortInMillis()

Description copied from interface: IModel

Gets the time required to perform the post-loading Hilbert sort on the vertices, in milliseconds. This value is used to format performance reports.

Specified by:

getTimeToSortInMillis in interface IModel

Returns:

a positive long integer.

getPerimeterVertices

public List<org.tinfour.common.Vertex> getPerimeterVertices()

Description copied from interface: IModel

Gets a list of the vertices that lie on the perimeter of the TIN. The perimeter should be a convex polygon.

Specified by:

getPerimeterVertices in interface IModel

Returns:

a list of vertices.

getLinearUnits

public org.tinfour.utils.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.

Specified by:

getLinearUnits in interface IModel

Returns:

at this time, the method always returns LinearUnits.UNDEFINED

isCoordinateSystemGeographic

public boolean isCoordinateSystemGeographic()

Description copied from interface: IModel

Indicates whether the coordinates used by this instance are geographic in nature.

Specified by:

isCoordinateSystemGeographic in interface IModel

Returns:

true if coordinates are geographic; otherwise, false.

getVertexForIndex

public org.tinfour.common.Vertex getVertexForIndex(int index)

Description copied from interface: IModel

Get the vertex with the specified vertex index.

Specified by:

getVertexForIndex in interface IModel

Parameters:

index - an arbitrary integer.

Returns:

if matched, a valid vertex; otherwise, a null;

xy2geo

public void xy2geo(double x,
                   double y,
                   double[] geo)

Description copied from interface: IModel

If defined, converts a pair of scaled Cartesian coordinates to a latitude and longitude. If undefined, no operation is performed.

Specified by:

xy2geo in interface IModel

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

public void geo2xy(double latitude,
                   double longitude,
                   double[] xy)

Description copied from interface: IModel

If defined, converts a pair of geographic (latitude,longitude) coordinates to a pair of scaled Cartesian coordinates. If undefined, no operation is performed.

Specified by:

geo2xy in interface IModel

Parameters:

latitude - the latitude

longitude - the longitude

xy - a array of dimension two to store the results.

hasConstraints

public boolean hasConstraints()

Description copied from interface: IModel

Indicates whether the model has constraints and is thus a Constrained Delaunay Triangulation (CDT).

Specified by:

hasConstraints in interface IModel

Returns:

true if the model has constraints.

getConstraints

public List<org.tinfour.common.IConstraint> getConstraints()

Description copied from interface: IModel

Gets the current list of constraints for the model/

Specified by:

getConstraints in interface IModel

Returns:

a valid, potentially empty list.

hasVertexSource

public boolean hasVertexSource()

Description copied from interface: IModel

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

Specified by:

hasVertexSource in interface IModel

Returns:

true if the model has a source of vertices; otherwise false.

areVerticesLoaded

public boolean areVerticesLoaded()

Description copied from interface: IModel

Indicates if the vertex source for the model has been loaded

Specified by:

areVerticesLoaded in interface IModel

Returns:

true if the vertices for the model have been loaded; otherwise, false.

hasConstraintsSource

public boolean hasConstraintsSource()

Description copied from interface: IModel

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

Specified by:

hasConstraintsSource in interface IModel

Returns:

true if the model has a source of vertices; otherwise false.

areConstraintsLoaded

public boolean areConstraintsLoaded()

Description copied from interface: IModel

Indicates if the constraint source for the model has been loaded

Specified by:

areConstraintsLoaded in interface IModel

Returns:

true if the vertices for the model have been loaded; otherwise, false.

addConstraints

public void addConstraints(File constraintsFile,
                           List<org.tinfour.common.IConstraint> constraints)

Description copied from interface: IModel

Adds constraints to the model

Specified by:

addConstraints in interface IModel

Parameters:

constraintsFile - if the constraints were derived from a file, a valid reference; otherwise, a null

constraints - a valid list of constraints.

getCoordinateTransform

public org.tinfour.utils.loaders.ICoordinateTransform getCoordinateTransform()

Description copied from interface: IModel

Gets the coordinate transform associated with the model. If no transform is set, this method will return a null

Specified by:

getCoordinateTransform in interface IModel

Returns:

if set, a valid transform; otherwise, a null.