pygplates.ScalarType

class pygplates.ScalarType

Bases: instance

The namespace-qualified type of scalar values.

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

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

• pygplates.ScalarType.gpml_crustal_thickness

• pygplates.ScalarType.gpml_crustal_stretching_factor

• pygplates.ScalarType.gpml_crustal_thinning_factor

• pygplates.ScalarType.gpml_tectonic_subsidence

A ScalarType can also be pickled.

Changed in version 0.42: Added pickle support.

__init__()

You cannot directly instantiate this class from Python.

Note

This constructor is only provided for pickle support.

Methods

__init__	You cannot directly instantiate this class from Python.
create_from_qualified_string(name)	[staticmethod] Creates a ScalarType instance from a fully qualified name string.
create_gml(name)	[staticmethod] Create a scalar type qualified with the gml: prefix (gml: + name).
create_gpml(name)	[staticmethod] Create a scalar type qualified with the gpml: prefix (gpml: + name).
create_xsi(name)	[staticmethod] Create a scalar type 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

gpml_crustal_stretching_factor
gpml_crustal_thickness
gpml_crustal_thinning_factor
gpml_tectonic_subsidence

static create_from_qualified_string(name)

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

Parameters:

name (string) – qualified name

Return type:

ScalarType or None

The name string should have a : character separating the namespace alias from the unqualified name, for example gpml:VelocityColat. 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.

gpml_velocity_colat_scalar_type = pygplates.ScalarType.create_from_qualified_string('gpml:VelocityColat')

static create_gml(name)

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

Parameters:

name (string) – unqualified name

Return type:

ScalarType

static create_gpml(name)

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

Parameters:

name (string) – unqualified name

Return type:

ScalarType

gpml_velocity_colat_scalar_type = pygplates.ScalarType.create_gpml('VelocityColat')

static create_xsi(name)

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

Parameters:

name (string) – unqualified name

Return type:

ScalarType

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, VelocityColat.

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:VelocityColat.