Package com.luciad.format.gml32.model
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
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.luciad.shape.ILcdTimeBounds
ILcdTimeBounds.Boundedness
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TLcdDataProperty
Data property that maps to the choice between thebeginPosition
andbegin
elements.static final TLcdDataProperty
Data property that maps to the choice between theendPosition
andend
elements.static final TLcdDataProperty
Data property that maps to the choice between theduration
andtimeInterval
elements.Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeGeometricPrimitive
FRAME_PROPERTY
Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimePrimitive
RELATED_TIME_PROPERTY
Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY
-
Constructor Summary
ConstructorDescriptionCreates a new time period.TLcdGML32TimePeriod
(TLcdDataType aType) TLcdGML32TimePeriod
(TLcdGML32TimePosition aBegin, TLcdGML32TimePosition aEnd) Creates a new time period based on the given begin and end time positions. -
Method Summary
Modifier and TypeMethodDescriptiongetBegin()
Returns the value of the property that maps to the choice between thebeginPosition
andbegin
elements.long
Returns the begin time of thisILcdTimeBounds
.Returns the boundedness of the begin time.getEnd()
Returns the value of the property that maps to the choice between theendPosition
andend
elements.long
Returns the end time of thisILcdTimeBounds
.Returns the boundedness of the end time.Returns the value of the property that maps to the choice between theduration
andtimeInterval
elements.void
setBegin
(ILcdDataObject aValue) Sets the value of the property that maps to the choice between thebeginPosition
andbegin
elements.void
setEnd
(ILcdDataObject aValue) Sets the value of the property that maps to the choice between theendPosition
andend
elements.void
Sets the value of the property that maps to the choice between theduration
andtimeInterval
elements.Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeGeometricPrimitive
getFrame, setFrame
Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimePrimitive
getRelatedTime
Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier
-
Field Details
-
BEGIN_PROPERTY
Data property that maps to the choice between thebeginPosition
andbegin
elements. The possible values for this property are instances of -
END_PROPERTY
Data property that maps to the choice between theendPosition
andend
elements. The possible values for this property are instances of -
LENGTH_PROPERTY
Data property that maps to the choice between theduration
andtimeInterval
elements. The possible values for this property are instances ofDuration
TLcdGML32TimeIntervalLength
-
-
Constructor Details
-
TLcdGML32TimePeriod
public TLcdGML32TimePeriod()Creates a new time period. -
TLcdGML32TimePeriod
-
TLcdGML32TimePeriod
Creates a new time period based on the given begin and end time positions.- Parameters:
aBegin
- the new begin valueaEnd
- the new end value- Since:
- 2017.0
-
-
Method Details
-
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 interfaceILcdTimeBounds
- Returns:
- the boundedness of the begin time.
- Since:
- 2017.0
-
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 interfaceILcdTimeBounds
- Returns:
- the boundedness of the end time.
- Since:
- 2017.0
-
getBeginTime
public long getBeginTime()Returns the begin time of thisILcdTimeBounds
. The long value is defined as inDate.getTime()
. This method should only be called if the corresponding boundedness isILcdTimeBounds.Boundedness.BOUNDED
. Otherwise, the return value of this method is undefined.- Specified by:
getBeginTime
in interfaceILcdTimeBounds
- Returns:
- the begin time of this
ILcdTimeBounds
. - Since:
- 2017.0
-
getEndTime
public long getEndTime()Returns the end time of thisILcdTimeBounds
. The long value is defined as inDate.getTime()
. This method should only be called if the corresponding boundedness isILcdTimeBounds.Boundedness.BOUNDED
. Otherwise, the return value of this method is undefined.- Specified by:
getEndTime
in interfaceILcdTimeBounds
- Returns:
- the end time of this
ILcdTimeBounds
. - Since:
- 2017.0
-
getBegin
Returns the value of the property that maps to the choice between thebeginPosition
andbegin
elements.The possible values for this property are instances of
- Returns:
- the value of the
BEGIN_PROPERTY
property.
-
setBegin
Sets the value of the property that maps to the choice between thebeginPosition
andbegin
elements.The possible values for this property are instances of
- Parameters:
aValue
- the value to set for theBEGIN_PROPERTY
property.
-
getEnd
Returns the value of the property that maps to the choice between theendPosition
andend
elements.The possible values for this property are instances of
- Returns:
- the value of the
END_PROPERTY
property.
-
setEnd
Sets the value of the property that maps to the choice between theendPosition
andend
elements.The possible values for this property are instances of
- Parameters:
aValue
- the value to set for theEND_PROPERTY
property.
-
getLength
Returns the value of the property that maps to the choice between theduration
andtimeInterval
elements.The possible values for this property are instances of
Duration
TLcdGML32TimeIntervalLength
- Returns:
- the value of the
LENGTH_PROPERTY
property.
-
setLength
Sets the value of the property that maps to the choice between theduration
andtimeInterval
elements.The possible values for this property are instances of
Duration
TLcdGML32TimeIntervalLength
- Parameters:
aValue
- the value to set for theLENGTH_PROPERTY
property.
-