Skip to content

commonmodule

This is the common module.

This module contains geographic metadata structures derived from the Common Classes package in the ISO 19111:2019 international standard.

IdentifiedObject

Bases: ABC

Identifications of a CRS-related object.

Source code in opengis/referencing/common.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class IdentifiedObject(ABC):
    """Identifications of a CRS-related object."""

    @property
    @abstractmethod
    def name(self) -> Identifier:
        """The primary name by which this object is identified."""

    @property
    @abstractmethod
    def identifier(self) -> Optional[Sequence[Identifier]]:
        """
        An identifier which references elsewhere the object's defining
        information; alternatively an identifier by which this object can be
        referenced.
        """

    @property
    @abstractmethod
    def alias(self) -> Optional[Sequence[GenericName]]:
        """An alternative name by which this object is identified."""

    @property
    @abstractmethod
    def remarks(self) -> Optional[Sequence[str]]:
        """
        Comments on or information about this object, including data source
        information.
        """

    @property
    @abstractmethod
    def domain(self) -> Optional[Sequence[ObjectDomain]]:
        """The scope and validity of the object."""

    @abstractmethod
    def to_wkt(self) -> str:
        """Returns a Well-Known Text (WKT) for this object."""

alias: Optional[Sequence[GenericName]] abstractmethod property

An alternative name by which this object is identified.

domain: Optional[Sequence[ObjectDomain]] abstractmethod property

The scope and validity of the object.

identifier: Optional[Sequence[Identifier]] abstractmethod property

An identifier which references elsewhere the object's defining information; alternatively an identifier by which this object can be referenced.

name: Identifier abstractmethod property

The primary name by which this object is identified.

remarks: Optional[Sequence[str]] abstractmethod property

Comments on or information about this object, including data source information.

to_wkt() abstractmethod

Returns a Well-Known Text (WKT) for this object.

Source code in opengis/referencing/common.py 
89
90
91
@abstractmethod
def to_wkt(self) -> str:
    """Returns a Well-Known Text (WKT) for this object."""

ObjectDomain

Bases: ABC

The scope and validity of a CRS-related object.

Source code in opengis/referencing/common.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class ObjectDomain(ABC):
    """The scope and validity of a CRS-related object."""

    @property
    @abstractmethod
    def scope(self) -> str:
        """
        Description of usage, or limitations of usage, for which this object
        is valid. If unknown, enter "not known".
        """

    @property
    @abstractmethod
    def domain_of_validity(self) -> Extent:
        """The spatial and temporal extent in which this object is valid."""

domain_of_validity: Extent abstractmethod property

The spatial and temporal extent in which this object is valid.

scope: str abstractmethod property

Description of usage, or limitations of usage, for which this object is valid. If unknown, enter "not known".