Skip to content

d02_move

d02_move

Wrapper for move operation token.

D02Move

Bases: CommandToken

4.8.3 Move (D02).

Moves the current point to the (X,Y) in the comment. The syntax is:

D02 = (['X' x_coordinate] ['Y' y_coordinate] 'D02') '*';
  • x_coordinate - <Coordinate> is coordinate data - see section 0. It defines the X coordinate of the new current point. The default is the X coordinate of the old current point.
  • y_coordinate - As above, but for the Y coordinate.
  • D02 - Move operation code
Example
X2152000Y1215000D02*

See section 4.8.3 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/d02_move.py 
 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
 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
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
class D02Move(CommandToken):
    """## 4.8.3 Move (D02).

    Moves the current point to the (X,Y) in the comment. The syntax is:

    ```ebnf
    D02 = (['X' x_coordinate] ['Y' y_coordinate] 'D02') '*';
    ```

    - x_coordinate - `<Coordinate>` is coordinate data - see section 0. It defines the X
        coordinate of the new current point. The default is the X coordinate of
        the old current point.
    - y_coordinate - As above, but for the Y coordinate.
    - D02 - Move operation code

    ---

    ## Example

    ```gerber
    X2152000Y1215000D02*
    ```

    ---

    See section 4.8.3 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=83)

    """

    def __init__(
        self,
        string: str,
        location: int,
        x: Coordinate,
        y: Coordinate,
    ) -> None:
        super().__init__(string, location)
        self.x = x
        self.y = y

    @classmethod
    def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
        """Create instance of this class.

        Created to be used as callback in `ParserElement.set_parse_action()`.
        """
        x = tokens.get("x")
        x = Coordinate.new(
            coordinate_type=CoordinateType.X,
            offset=str(x) if x is not None else None,
        )
        y = tokens.get("y")
        y = Coordinate.new(
            coordinate_type=CoordinateType.Y,
            offset=str(y) if y is not None else None,
        )

        return cls(
            string=string,
            location=location,
            x=x,
            y=y,
        )

    def update_drawing_state(
        self,
        state: State,
        _backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Set coordinate parser."""
        x = state.parse_coordinate(self.x)
        y = state.parse_coordinate(self.y)

        position = Vector2D(x=x, y=y)
        return (
            state.model_copy(
                update={
                    "current_position": position,
                },
            ),
            (),
        )

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().command_move.pre_parser_visit_token(self, context)
        context.get_hooks().command_move.on_parser_visit_token(self, context)
        context.get_hooks().command_move.post_parser_visit_token(self, context)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",
    ) -> str:
        """Get gerber code represented by this token."""
        return (
            f"{indent}"
            f"{self.x.get_gerber_code(indent, endline)}"
            f"{self.y.get_gerber_code(indent, endline)}"
            "D02"
        )

    def get_state_based_hover_message(
        self,
        state: State,
    ) -> str:
        """Return operation specific extra information about token."""
        units = state.get_units()

        x0 = state.current_position.x.as_unit(units)
        y0 = state.current_position.x.as_unit(units)

        x1 = state.parse_coordinate(self.x).as_unit(units)
        y1 = state.parse_coordinate(self.y).as_unit(units)

        u = units.value.lower()

        return f"Move from (`{x0}`{u}, `{y0}`{u}) to (`{x1}`{u}, `{y1}`{u})"

new classmethod 

new(
    string: str, location: int, tokens: ParseResults
) -> Self

Create instance of this class.

Created to be used as callback in ParserElement.set_parse_action().

Source code in src/pygerber/gerberx3/tokenizer/tokens/d02_move.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@classmethod
def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
    """Create instance of this class.

    Created to be used as callback in `ParserElement.set_parse_action()`.
    """
    x = tokens.get("x")
    x = Coordinate.new(
        coordinate_type=CoordinateType.X,
        offset=str(x) if x is not None else None,
    )
    y = tokens.get("y")
    y = Coordinate.new(
        coordinate_type=CoordinateType.Y,
        offset=str(y) if y is not None else None,
    )

    return cls(
        string=string,
        location=location,
        x=x,
        y=y,
    )

update_drawing_state 

update_drawing_state(
    state: State, _backend: Backend
) -> Tuple[State, Iterable[DrawCommand]]

Set coordinate parser.

Source code in src/pygerber/gerberx3/tokenizer/tokens/d02_move.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def update_drawing_state(
    self,
    state: State,
    _backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Set coordinate parser."""
    x = state.parse_coordinate(self.x)
    y = state.parse_coordinate(self.y)

    position = Vector2D(x=x, y=y)
    return (
        state.model_copy(
            update={
                "current_position": position,
            },
        ),
        (),
    )

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/d02_move.py 
103
104
105
106
107
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().command_move.pre_parser_visit_token(self, context)
    context.get_hooks().command_move.on_parser_visit_token(self, context)
    context.get_hooks().command_move.post_parser_visit_token(self, context)

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/d02_move.py 
109
110
111
112
113
114
115
116
117
118
119
120
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",
) -> str:
    """Get gerber code represented by this token."""
    return (
        f"{indent}"
        f"{self.x.get_gerber_code(indent, endline)}"
        f"{self.y.get_gerber_code(indent, endline)}"
        "D02"
    )

get_state_based_hover_message 

get_state_based_hover_message(state: State) -> str

Return operation specific extra information about token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/d02_move.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def get_state_based_hover_message(
    self,
    state: State,
) -> str:
    """Return operation specific extra information about token."""
    units = state.get_units()

    x0 = state.current_position.x.as_unit(units)
    y0 = state.current_position.x.as_unit(units)

    x1 = state.parse_coordinate(self.x).as_unit(units)
    y1 = state.parse_coordinate(self.y).as_unit(units)

    u = units.value.lower()

    return f"Move from (`{x0}`{u}, `{y0}`{u}) to (`{x1}`{u}, `{y1}`{u})"