/*
* Geotoolkit - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2008 - 2009, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotoolkit.gml.xml.v311;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlElementRefs;
import javax.xml.bind.annotation.XmlType;
/**
* Cubic splines are similar to line strings in that they are a sequence of segments each with its own defining function. A cubic spline uses the control points and a set of derivative parameters to define a piecewise 3rd degree polynomial interpolation. Unlike line-strings, the parameterization by arc length is not necessarily still a polynomial.
* The function describing the curve must be C2, that is, have a continuous 1st and 2nd derivative at all points, and pass through the controlPoints in the order given. Between the control points, the curve segment is defined by a cubic polynomial. At each control point, the polynomial changes in such a manner that the 1st and 2nd derivative vectors are the same from either side. The control parameters record must contain vectorAtStart, and vectorAtEnd which are the unit tangent vectors at controlPoint[1] and controlPoint[n] where n = controlPoint.count.
* Note: only the direction of the vectors is relevant, not their length.
*
* <p>Java class for CubicSplineType complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="CubicSplineType">
* <complexContent>
* <extension base="{http://www.opengis.net/gml}AbstractCurveSegmentType">
* <sequence>
* <choice>
* <choice maxOccurs="unbounded" minOccurs="2">
* <element ref="{http://www.opengis.net/gml}pos"/>
* <element ref="{http://www.opengis.net/gml}pointProperty"/>
* <element ref="{http://www.opengis.net/gml}pointRep"/>
* </choice>
* <element ref="{http://www.opengis.net/gml}posList"/>
* <element ref="{http://www.opengis.net/gml}coordinates"/>
* </choice>
* <element name="vectorAtStart" type="{http://www.opengis.net/gml}VectorType"/>
* <element name="vectorAtEnd" type="{http://www.opengis.net/gml}VectorType"/>
* </sequence>
* <attribute name="interpolation" type="{http://www.opengis.net/gml}CurveInterpolationType" fixed="cubicSpline" />
* <attribute name="degree" type="{http://www.w3.org/2001/XMLSchema}integer" fixed="3" />
* </extension>
* </complexContent>
* </complexType>
* </pre>
*
*
* @module
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CubicSplineType", propOrder = {
"posOrPointPropertyOrPointRep",
"posList",
"coordinates",
"vectorAtStart",
"vectorAtEnd"
})
public class CubicSplineType
extends AbstractCurveSegmentType
{
@XmlElementRefs({
@XmlElementRef(name = "pointProperty", namespace = "http://www.opengis.net/gml", type = JAXBElement.class),
@XmlElementRef(name = "pos", namespace = "http://www.opengis.net/gml", type = JAXBElement.class),
@XmlElementRef(name = "pointRep", namespace = "http://www.opengis.net/gml", type = JAXBElement.class)
})
protected List<JAXBElement<?>> posOrPointPropertyOrPointRep;
protected DirectPositionListType posList;
protected CoordinatesType coordinates;
@XmlElement(required = true)
protected VectorType vectorAtStart;
@XmlElement(required = true)
protected VectorType vectorAtEnd;
@XmlAttribute
protected CurveInterpolationType interpolation;
@XmlAttribute
protected Integer degree;
/**
* Gets the value of the posOrPointPropertyOrPointRep property.
*
* <p>
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a <CODE>set</CODE> method for the posOrPointPropertyOrPointRep property.
*
* <p>
* For example, to add a new item, do as follows:
* <pre>
* getPosOrPointPropertyOrPointRep().add(newItem);
* </pre>
*
*
* <p>
* Objects of the following type(s) are allowed in the list
* {@link JAXBElement }{@code <}{@link DirectPositionType }{@code >}
* {@link JAXBElement }{@code <}{@link PointPropertyType }{@code >}
* {@link JAXBElement }{@code <}{@link PointPropertyType }{@code >}
*
*
*/
public List<JAXBElement<?>> getPosOrPointPropertyOrPointRep() {
if (posOrPointPropertyOrPointRep == null) {
posOrPointPropertyOrPointRep = new ArrayList<JAXBElement<?>>();
}
return this.posOrPointPropertyOrPointRep;
}
/**
* Gets the value of the posList property.
*
* @return
* possible object is
* {@link DirectPositionListType }
*
*/
public DirectPositionListType getPosList() {
return posList;
}
/**
* Sets the value of the posList property.
*
* @param value
* allowed object is
* {@link DirectPositionListType }
*
*/
public void setPosList(final DirectPositionListType value) {
this.posList = value;
}
/**
* Deprecated with GML version 3.1.0. Use "posList" instead.
*
* @return
* possible object is
* {@link CoordinatesType }
*
*/
public CoordinatesType getCoordinates() {
return coordinates;
}
/**
* Deprecated with GML version 3.1.0. Use "posList" instead.
*
* @param value
* allowed object is
* {@link CoordinatesType }
*
*/
public void setCoordinates(final CoordinatesType value) {
this.coordinates = value;
}
/**
* Gets the value of the vectorAtStart property.
*
* @return
* possible object is
* {@link VectorType }
*
*/
public VectorType getVectorAtStart() {
return vectorAtStart;
}
/**
* Sets the value of the vectorAtStart property.
*
* @param value
* allowed object is
* {@link VectorType }
*
*/
public void setVectorAtStart(final VectorType value) {
this.vectorAtStart = value;
}
/**
* Gets the value of the vectorAtEnd property.
*
* @return
* possible object is
* {@link VectorType }
*
*/
public VectorType getVectorAtEnd() {
return vectorAtEnd;
}
/**
* Sets the value of the vectorAtEnd property.
*
* @param value
* allowed object is
* {@link VectorType }
*
*/
public void setVectorAtEnd(final VectorType value) {
this.vectorAtEnd = value;
}
/**
* Gets the value of the interpolation property.
*
* @return
* possible object is
* {@link CurveInterpolationType }
*
*/
public CurveInterpolationType getInterpolation() {
if (interpolation == null) {
return CurveInterpolationType.CUBIC_SPLINE;
} else {
return interpolation;
}
}
/**
* Sets the value of the interpolation property.
*
* @param value
* allowed object is
* {@link CurveInterpolationType }
*
*/
public void setInterpolation(final CurveInterpolationType value) {
this.interpolation = value;
}
/**
* Gets the value of the degree property.
*
* @return
* possible object is
* {@link Integer }
*
*/
public Integer getDegree() {
if (degree == null) {
return 3;
} else {
return degree;
}
}
/**
* Sets the value of the degree property.
*
* @param value
* allowed object is
* {@link Integer }
*
*/
public void setDegree(final Integer value) {
this.degree = value;
}
}