Skip to content

coordinate

coordinate

Coordinate wrapper class.

Coordinate

Bases: GerberCode, FrozenGeneralModel

Coordinate data.

A number whose interpretation is determined by the FS command. It is used to specify the X and Y coordinates of a point in the image plane and a distance or offset in the X and Y direction.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class Coordinate(GerberCode, FrozenGeneralModel):
    """## Coordinate data.

    A number whose interpretation is determined by the FS command. It is used to specify
    the X and Y coordinates of a point in the image plane and a distance
    or offset in the X and Y direction.
    """

    coordinate_type: CoordinateType
    sign: CoordinateSign
    offset: str

    @classmethod
    def new(cls, coordinate_type: CoordinateType, offset: Optional[str]) -> Self:
        """Create new Coordinate object."""
        if offset is None:
            coordinate_type = coordinate_type.to_missing()
            offset = ""
            sign = CoordinateSign.Positive

        elif len(offset) > 0 and offset[0] in "+-":
            sign = CoordinateSign(offset[0])
            offset = offset[1:].ljust(1, "0")

        else:
            sign = CoordinateSign.Positive

        return cls(coordinate_type=coordinate_type, sign=sign, offset=offset)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",  # noqa: ARG002
    ) -> str:
        """Get gerber code represented by this token."""
        return (
            ""
            if self.coordinate_type.is_missing()
            else f"{indent}{self.coordinate_type}{self.sign}{self.offset}"
        )

new classmethod 

new(
    coordinate_type: CoordinateType, offset: Optional[str]
) -> Self

Create new Coordinate object.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@classmethod
def new(cls, coordinate_type: CoordinateType, offset: Optional[str]) -> Self:
    """Create new Coordinate object."""
    if offset is None:
        coordinate_type = coordinate_type.to_missing()
        offset = ""
        sign = CoordinateSign.Positive

    elif len(offset) > 0 and offset[0] in "+-":
        sign = CoordinateSign(offset[0])
        offset = offset[1:].ljust(1, "0")

    else:
        sign = CoordinateSign.Positive

    return cls(coordinate_type=coordinate_type, sign=sign, offset=offset)

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
43
44
45
46
47
48
49
50
51
52
53
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return (
        ""
        if self.coordinate_type.is_missing()
        else f"{indent}{self.coordinate_type}{self.sign}{self.offset}"
    )

CoordinateType

Bases: Enum

Type of coordinate axis/meaning.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
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
class CoordinateType(Enum):
    """Type of coordinate axis/meaning."""

    X = "X"
    Y = "Y"
    I = "I"  # noqa: E741
    J = "J"
    NULL = ""
    MISSING_X = "MISSING_X"
    MISSING_Y = "MISSING_Y"
    MISSING_I = "MISSING_I"
    MISSING_J = "MISSING_J"

    def to_missing(self) -> CoordinateType:
        """Map <coordinate> to MISSING_<coordinate>."""
        return _coordinate_type_to_missing_map[self]

    def is_missing(self) -> bool:
        """Check if coordinate is one of variants of missing coordinates."""
        return self in (
            CoordinateType.MISSING_X,
            CoordinateType.MISSING_Y,
            CoordinateType.MISSING_I,
            CoordinateType.MISSING_J,
        )

    def __str__(self) -> str:
        return self.value

to_missing 

to_missing() -> CoordinateType

Map to MISSING_.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
69
70
71
def to_missing(self) -> CoordinateType:
    """Map <coordinate> to MISSING_<coordinate>."""
    return _coordinate_type_to_missing_map[self]

is_missing 

is_missing() -> bool

Check if coordinate is one of variants of missing coordinates.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
73
74
75
76
77
78
79
80
def is_missing(self) -> bool:
    """Check if coordinate is one of variants of missing coordinates."""
    return self in (
        CoordinateType.MISSING_X,
        CoordinateType.MISSING_Y,
        CoordinateType.MISSING_I,
        CoordinateType.MISSING_J,
    )

CoordinateSign

Bases: Enum

Coordinate sign.

Source code in src/pygerber/gerberx3/tokenizer/tokens/coordinate.py 
 94
 95
 96
 97
 98
 99
100
101
class CoordinateSign(Enum):
    """Coordinate sign."""

    Positive = "+"
    Negative = "-"

    def __str__(self) -> str:
        return "-" if self == CoordinateSign.Negative else ""