Class TLcdGML32TimePeriod

All Implemented Interfaces:
ILcdDataObject, ILcdTimeBounds, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdGML32TimePeriod extends TLcdGML32AbstractTimeGeometricPrimitive implements ILcdTimeBounds
A GML period acts as a one-dimensional geometric primitive that represents an identifiable extent in time, usually defined by two time positions or time instants. The location in of a gml:TimePeriod is described by the temporal positions of the instants at which it begins and ends. The length of the period is equal to the temporal distance between the two bounding temporal positions. Both beginning and end may be described in terms of their direct position using gml:TimePositionType which is an XML Schema simple content type, or by reference to an indentifiable time instant using gml:TimeInstantPropertyType. Alternatively a limit of a gml:TimePeriod may use the conventional GML property model to make a reference to a time instant described elsewhere, or a limit may be indicated as a direct position.

For convenience, this class also implements ILcdTimeBounds.

Since:
10.0
  • Field Details

  • Constructor Details

    • TLcdGML32TimePeriod

      public TLcdGML32TimePeriod()
      Creates a new time period.
    • TLcdGML32TimePeriod

      public TLcdGML32TimePeriod(TLcdDataType aType)
    • TLcdGML32TimePeriod

      public TLcdGML32TimePeriod(TLcdGML32TimePosition aBegin, TLcdGML32TimePosition aEnd)
      Creates a new time period based on the given begin and end time positions.
      Parameters:
      aBegin - the new begin value
      aEnd - the new end value
      Since:
      2017.0
  • Method Details

    • getBeginTimeBoundedness

      public ILcdTimeBounds.Boundedness getBeginTimeBoundedness()
      Returns the boundedness of the begin time. This method can be used to check whether the begin time is undefined, bounded or unbounded.
      Specified by:
      getBeginTimeBoundedness in interface ILcdTimeBounds
      Returns:
      the boundedness of the begin time.
      Since:
      2017.0
    • getEndTimeBoundedness

      public ILcdTimeBounds.Boundedness getEndTimeBoundedness()
      Returns the boundedness of the end time. This method can be used to check whether the end time is undefined, bounded or unbounded.
      Specified by:
      getEndTimeBoundedness in interface ILcdTimeBounds
      Returns:
      the boundedness of the end time.
      Since:
      2017.0
    • getBeginTime

      public long getBeginTime()
      Returns the begin time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

      This method should only be called if the corresponding boundedness is ILcdTimeBounds.Boundedness.BOUNDED. Otherwise, the return value of this method is undefined.

      Specified by:
      getBeginTime in interface ILcdTimeBounds
      Returns:
      the begin time of this ILcdTimeBounds.
      Since:
      2017.0
    • getEndTime

      public long getEndTime()
      Returns the end time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

      This method should only be called if the corresponding boundedness is ILcdTimeBounds.Boundedness.BOUNDED. Otherwise, the return value of this method is undefined.

      Specified by:
      getEndTime in interface ILcdTimeBounds
      Returns:
      the end time of this ILcdTimeBounds.
      Since:
      2017.0
    • getBegin

      public ILcdDataObject getBegin()
      Returns the value of the property that maps to the choice between the beginPosition and begin elements.

      The possible values for this property are instances of

      Returns:
      the value of the BEGIN_PROPERTY property.
    • setBegin

      public void setBegin(ILcdDataObject aValue)
      Sets the value of the property that maps to the choice between the beginPosition and begin elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the BEGIN_PROPERTY property.
    • getEnd

      public ILcdDataObject getEnd()
      Returns the value of the property that maps to the choice between the endPosition and end elements.

      The possible values for this property are instances of

      Returns:
      the value of the END_PROPERTY property.
    • setEnd

      public void setEnd(ILcdDataObject aValue)
      Sets the value of the property that maps to the choice between the endPosition and end elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the END_PROPERTY property.
    • getLength

      public Object getLength()
      Returns the value of the property that maps to the choice between the duration and timeInterval elements.

      The possible values for this property are instances of

      Returns:
      the value of the LENGTH_PROPERTY property.
    • setLength

      public void setLength(Object aValue)
      Sets the value of the property that maps to the choice between the duration and timeInterval elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the LENGTH_PROPERTY property.