pygplates.PropertyName

class pygplates.PropertyName

Bases: Boost.Python.instance

The namespace-qualified name of a property.

All comparison operators (==, !=, <, <=, >, >=) are supported. PropertyName is hashable (can be used as a key in a dict).

As a convenience the following common property names are available as class attributes:

As a convenience the following common enumeration property names are available as class attributes:

As a convenience the following common geometry property names are available as class attributes:

__init__()

Raises an exception This class cannot be instantiated from Python

Methods

__init__

Raises an exception This class cannot be instantiated from Python

create_from_qualified_string(name)

[staticmethod] Creates a PropertyName instance from a fully qualified name string.

create_gml(name)

[staticmethod] Create a property name qualified with the gml: prefix (gml: + name).

create_gpml(name)

[staticmethod] Create a property name qualified with the gpml: prefix (gpml: + name).

create_xsi(name)

[staticmethod] Create a property name qualified with the xsi: prefix (xsi: + name).

get_name()

Returns the unqualified name.

get_namespace()

Returns the namespace URI.

get_namespace_alias()

Returns the namespace alias.

to_qualified_string()

Returns the fully qualified name.

Attributes

gml_description

gml_name

gml_valid_time

gpml_absolute_reference_frame

gpml_average_age

gpml_average_declination

gpml_average_inclination

gpml_average_sample_site_position

gpml_boundary

gpml_center_line_of

gpml_conjugate_plate_id

gpml_crust

gpml_dip_side

gpml_dip_slip

gpml_edge

gpml_error_bounds

gpml_fixed_reference_frame

gpml_fold_annotation

gpml_geometry_import_time

gpml_left_plate

gpml_motion

gpml_moving_reference_frame

gpml_multi_position

gpml_network

gpml_outline_of

gpml_polarity_chron_id

gpml_polarity_chron_offset

gpml_polarity_chron_orientation

gpml_pole_a95

gpml_pole_dm

gpml_pole_dp

gpml_pole_position

gpml_position

gpml_primary_slip_component

gpml_quality

gpml_reconstruction_method

gpml_reconstruction_plate_id

gpml_relative_plate

gpml_right_plate

gpml_seed_points

gpml_shapefile_attributes

gpml_side

gpml_strike_slip

gpml_subduction_polarity

gpml_times

gpml_total_reconstruction_pole

gpml_unclassified_geometry

static create_from_qualified_string(name)

[staticmethod] Creates a PropertyName instance from a fully qualified name string.

Parameters

name (string) – qualified name

Return type

PropertyName or None

The name string should have a : character separating the namespace alias from the unqualified name, for example gpml:reconstructionPlateId. If the namespace alias is not recognised (as gpml, gml or xsi) then gpml is assumed.

An over-qualified name string (eg, containing two or more : characters) will result in None being returned.

property_name = pygplates.PropertyName.create_from_qualified_string('gpml:reconstructionPlateId')
static create_gml(name)

[staticmethod] Create a property name qualified with the gml: prefix (gml: + name).

Parameters

name (string) – unqualified name

Return type

PropertyName

gml_valid_time_property_name = pygplates.PropertyName.create_gml('validTime')
static create_gpml(name)

[staticmethod] Create a property name qualified with the gpml: prefix (gpml: + name).

Parameters

name (string) – unqualified name

Return type

PropertyName

gpml_reconstruction_plate_id_property_name = pygplates.PropertyName.create_gpml('reconstructionPlateId')
static create_xsi(name)

[staticmethod] Create a property name qualified with the xsi: prefix (xsi: + name).

Parameters

name (string) – unqualified name

Return type

PropertyName

property_name = pygplates.PropertyName.create_xsi(name)
get_name()

Returns the unqualified name.

Return type

string

This is the fully qualified name minus the gpml: prefix (if created with create_gpml()).

For example, reconstructionPlateId.

get_namespace()

Returns the namespace URI.

Return type

string

For example, the gpml namespace alias has the namespace http://www.gplates.org/gplates.

get_namespace_alias()

Returns the namespace alias.

Return type

string

For example, gpml (if created with create_gpml()).

to_qualified_string()

Returns the fully qualified name.

Return type

string

For example, gpml:reconstructionPlateId.