org.tinfour.gis.utils

Class ConstraintVertex

java.lang.Object

org.tinfour.common.Vertex

org.tinfour.gis.utils.ConstraintVertex

All Implemented Interfaces:

ISamplePoint

public class ConstraintVertex
extends Vertex

Provides a Vertex implementation with special labeling for indicating vertices that were contributed by a constraint

Field Summary

Fields inherited from class org.tinfour.common.Vertex

auxiliary, BIT_CONSTRAINT, BIT_SYNTHETIC, reserved0, reserved1, status, x, y

Constructor Summary

Constructors

Constructor and Description
ConstraintVertex(double x, double y, double z, int index) Construct a vertex with the specified coordinates and ID value.

Method Summary

Modifier and Type	Method and Description
String	getLabel() Gets a string intended for labeling the vertex in images or reports.
String	toString()

Methods inherited from class org.tinfour.common.Vertex

getAuxiliaryIndex, getDistance, getDistance, getDistanceSq, getDistanceSq, getIndex, getStatus, getX, getY, getZ, isConstraintMember, isNull, isSynthetic, setAuxiliaryIndex, setConstraintMember, setIndex, setStatus, setSynthetic

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintVertex

public ConstraintVertex(double x,
                        double y,
                        double z,
                        int index)

Construct a vertex with the specified coordinates and ID value. If the z value is NaN then the vertex will be treated as a "null data value".

Parameters:

x - the coordinate on the surface on which the vertex is defined

y - the coordinate on the surface on which the vertex is defined

z - the data value (z coordinate of the surface)

index - the ID of the vertex (intended as a diagnostic)

Method Detail

getLabel

public String getLabel()

Gets a string intended for labeling the vertex in images or reports. The default label is the index of the vertex preceeded by the letter C if the vertex is synthetic. Note that the index of a vertex is not necessarily unique. If constraints are loaded from multiple sources, some of their vertices will have the same indices.

Overrides:

getLabel in class Vertex

Returns:

a valid, non-empty string.

toString

public String toString()

Overrides:

toString in class Vertex