pygplates.Enumeration

class pygplates.Enumeration(type, content[, verify_information_model=VerifyInformationModel.yes])

Bases: pygplates.PropertyValue

A property value that represents a finite set of accepted (string) values per enumeration type.

__init__(type, content[, verify_information_model=VerifyInformationModel.yes])

Create an enumeration property value from an enumeration type and content (value).

Parameters:

• type (EnumerationType) – the type of the enumeration
• content (string) – the content (value) of the enumeration
• verify_information_model (VerifyInformationModel.yes or VerifyInformationModel.no) – whether to check the information model for valid enumeration type and content

Raises:

InformationModelError if verify_information_model is VerifyInformationModel.yes and either type is not a recognised enumeration type or content is not a valid value for type

dip_slip_enum = pygplates.Enumeration(
    pygplates.EnumerationType.create_gpml('DipSlipEnumeration'),
    'Extension')

Methods

__init__(type, content, ...)	Create an enumeration property value from an enumeration type and content (value).
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.
get_content()	Returns the content (value) of this enumeration.
get_geometry()	Extracts the geometry if this property value contains a geometry.
get_type()	Returns the type of this enumeration.
get_value([time=0])	Extracts the value, of this possibly time-dependent property value, at the reconstruction time.
set_content(content, ...)	Sets the content (value) of this enumeration.

accept_visitor(visitor)

Accept a property value visitor so that it can visit this property value. As part of the visitor pattern, this enables the visitor instance to discover the derived class type of this property. Note that there is no common interface shared by all property value types, hence the visitor pattern provides one way to find out which type of property value is being visited.

Parameters:visitor (PropertyValueVisitor) – the visitor instance visiting 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.

Return type:PropertyValue

get_content()

Returns the content (value) of this enumeration.

Return type:string

get_geometry()

Extracts the geometry if this property value contains a geometry.

Return type:GeometryOnSphere or None

This function searches for a geometry in the following standard geometry property value types:

• GmlPoint
• GmlMultiPoint
• GmlPolygon
• GmlLineString
• GmlOrientableCurve (a possible wrapper around GmlLineString)
• GpmlConstantValue (a possible wrapper around any of the above)

If this property value does not contain a geometry then None is returned.

Time-dependent geometry properties are not yet supported, so the only time-dependent property value wrapper currently supported by this function is GpmlConstantValue.

To extract geometry from a specific feature property:

property_value = feature.get_value(pygplates.PropertyName.gpml_pole_position)
if property_value:
    geometry = property_value.get_geometry()

...however Feature.get_geometry() provides an easier way to extract geometry from a feature with:

geometry = feature.get_geometry(pygplates.PropertyName.gpml_pole_position)

To extract all geometries from a feature (regardless of which properties they came from):

all_geometries = []
for property in feature:
    property_value = property.get_value()
    if property_value:
        geometry = property_value.get_geometry()
        if geometry:
            all_geometries.append(geometry)

...however again Feature.get_geometry() does this more easily with:

all_geometries = feature.get_geometry(lambda property: True, pygplates.PropertyReturn.all)

get_type()

Returns the type of this enumeration.

Return type:EnumerationType

get_value([time=0])

Extracts the value, of this possibly time-dependent property value, at the reconstruction time.

Parameters:time (float or GeoTimeInstant) – the time to extract value (defaults to present day) Return type:PropertyValue or None

If this property value is a time-dependent property (GpmlConstantValue, GpmlIrregularSampling or GpmlPiecewiseAggregation) then a nested property value is extracted at the reconstruction time and returned. Otherwise this property value instance is simply returned as is (since it’s not a time-dependent property value).

Returns None if this property value is a time-dependent property (GpmlConstantValue, GpmlIrregularSampling or GpmlPiecewiseAggregation) and time is outside its time range (of time samples or time windows).

Note that if this property value is a GpmlIrregularSampling instance then the extracted property value is interpolated (at reconstruction time) if property value can be interpolated (currently only GpmlFiniteRotation and XsDouble), otherwise None is returned.

The following example demonstrates extracting an interpolated finite rotation from a total reconstruction pole at time 20Ma:

gpml_finite_rotation_20Ma = total_reconstruction_pole.get_value(20)
if gpml_finite_rotation_20Ma:
  print 'Interpolated finite rotation at 20Ma: %s' % gpml_finite_rotation_20Ma.get_finite_rotation()

set_content(content[, verify_information_model=VerifyInformationModel.yes])

Sets the content (value) of this enumeration.

Parameters:

• content (string) – the content (value)
• verify_information_model (VerifyInformationModel.yes or VerifyInformationModel.no) – whether to check the information model for valid enumeration value

Raises:

InformationModelError if verify_information_model is VerifyInformationModel.yes and content is not a valid value for this enumeration type

dip_slip_enum.set_content('Extension')