pygplates.GmlTimePeriod¶

class pygplates.GmlTimePeriod¶

Bases: pygplates.PropertyValue

A property value representing a period in geological time (time of appearance to time of disappearance).

__init__(begin_time, end_time)¶

Create a property value representing a specific time period.

Parameters:	begin_time (float or `GeoTimeInstant`) – the begin time (time of appearance) end_time (float or `GeoTimeInstant`) – the end time (time of disappearance)
Raises:	GmlTimePeriodBeginTimeLaterThanEndTimeError if begin time is later than end time

time_period = pygplates.GmlTimePeriod(pygplates.GeoTimeInstant.create_distant_past(), 0)

Methods

`__init__`(begin_time, end_time)	Create a property value representing a specific time period.
`accept_visitor`(visitor)	Accept a property value visitor so that it can visit this property value.
`clone`()	Create a duplicate of this property value (derived) instance, including a recursive copy of any nested property values that this instance might contain.
`contains`(time_position)	Determine if a time lies within this time period.
`get_begin_time`()	Returns the begin time position (time of appearance) of this property value.
`get_end_time`()	Returns the end time position (time of disappearance) of this property value.
`get_geometry`()	Extracts the `geometry` if this property value contains a geometry.
`get_value`([time=0])	Extracts the value, of this possibly time-dependent property value, at the reconstruction time.
`set_begin_time`(time_position)	Sets the begin time position (time of appearance) of this property value.
`set_end_time`(time_position)	Sets the end time position (time of disappearance) of this property value.

contains(time_position)¶

Determine if a time lies within this time period.

Parameters:	time_position (float or `GeoTimeInstant`) – the time position to test
Return type:	bool

Note

time_position is considered to lie within a time period if it coincides with the begin or end time.

get_begin_time()¶

Returns the begin time position (time of appearance) of this property value.

Return type:	float

You can use GeoTimeInstant with the returned float to check for distant past or distant future for example. See GmlTimeInstant.get_time() for more details.

get_end_time()¶

Returns the end time position (time of disappearance) of this property value.

Return type:	float

You can use GeoTimeInstant with the returned float to check for distant past or distant future for example. See GmlTimeInstant.get_time() for more details.

set_begin_time(time_position)¶

Sets the begin time position (time of appearance) of this property value.

Parameters:	time_position (float or `GeoTimeInstant`) – the begin time position (time of appearance)
Raises:	GmlTimePeriodBeginTimeLaterThanEndTimeError if begin time is later than end time

set_end_time(time_position)¶

Sets the end time position (time of disappearance) of this property value.

Parameters:	time_position (float or `GeoTimeInstant`) – the end time position (time of disappearance)
Raises:	GmlTimePeriodBeginTimeLaterThanEndTimeError if begin time is later than end time