Skip to content

code_1_circle

code_1_circle

Macro primitives tokens.

Code1CircleToken

Bases: MacroPrimitiveToken

4.5.1.3 Circle, Code 1.

A circle primitive is defined by its center point and diameter.

Example
%AMCircle*
1,1,1.5,0,0,0*%

See section 4.5.1.3 of The Gerber Layer Format Specification

Source code in src\pygerber\gerberx3\tokenizer\tokens\macro\statements\code_1_circle.py 
 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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
class Code1CircleToken(MacroPrimitiveToken):
    """## 4.5.1.3 Circle, Code 1.

    A circle primitive is defined by its center point and diameter.

    ---

    ## Example

    ```gerber
    %AMCircle*
    1,1,1.5,0,0,0*%
    ```

    ---

    See section 4.5.1.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=60)

    """

    symbol: ClassVar[str] = "1"

    def __init__(
        self,
        string: str,
        location: int,
        exposure: MacroExpressionToken,
        diameter: MacroExpressionToken,
        center_x: MacroExpressionToken,
        center_y: MacroExpressionToken,
        rotation: MacroExpressionToken,
    ) -> None:
        super().__init__(string, location)
        self.exposure = exposure
        self.diameter = diameter
        self.center_x = center_x
        self.center_y = center_y
        self.rotation = rotation

    @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()`.
        """
        exposure = MacroExpressionToken.ensure_type(tokens["exposure"])
        diameter = MacroExpressionToken.ensure_type(tokens["diameter"])
        center_x = MacroExpressionToken.ensure_type(tokens["center_x"])
        center_y = MacroExpressionToken.ensure_type(tokens["center_y"])

        r = tokens.get("rotation")
        rotation: Optional[MacroExpressionToken] = (
            MacroExpressionToken.ensure_type(r) if r is not None else None
        )
        if rotation is None:
            rotation = NumericConstant(string, location, value=Decimal("0.0"))

        return cls(
            string=string,
            location=location,
            exposure=exposure,
            diameter=diameter,
            center_x=center_x,
            center_y=center_y,
            rotation=rotation,
        )

    def evaluate(
        self,
        macro_context: MacroContext,
        state: State,
        handle: PrivateApertureHandle,
    ) -> None:
        """Evaluate macro expression."""
        self.exposure.evaluate_numeric(macro_context, state)
        self.diameter.evaluate_numeric(macro_context, state)
        self.center_x.evaluate_numeric(macro_context, state)
        self.center_y.evaluate_numeric(macro_context, state)
        self.rotation.evaluate_numeric(macro_context, state)

        return super().evaluate(macro_context, state, handle)

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

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",
    ) -> str:
        """Get gerber code represented by this token."""
        string = self.symbol

        string += f",{self.exposure.get_gerber_code(indent, endline)}"
        string += f",{self.diameter.get_gerber_code(indent, endline)}"
        string += f",{self.center_x.get_gerber_code(indent, endline)}"
        string += f",{self.center_y.get_gerber_code(indent, endline)}"

        if self.rotation is not None:
            string += f",{self.rotation.get_gerber_code(indent, endline)}"

        return indent + string

    def __str__(self) -> str:
        string = super().__str__()

        string += f"\n  {self.exposure}"
        string += f"\n  {self.diameter}"
        string += f"\n  {self.center_x}"
        string += f"\n  {self.center_y}"

        if self.rotation is not None:
            string += f"\n  {self.rotation}"

        return string

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\macro\statements\code_1_circle.py 
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
@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()`.
    """
    exposure = MacroExpressionToken.ensure_type(tokens["exposure"])
    diameter = MacroExpressionToken.ensure_type(tokens["diameter"])
    center_x = MacroExpressionToken.ensure_type(tokens["center_x"])
    center_y = MacroExpressionToken.ensure_type(tokens["center_y"])

    r = tokens.get("rotation")
    rotation: Optional[MacroExpressionToken] = (
        MacroExpressionToken.ensure_type(r) if r is not None else None
    )
    if rotation is None:
        rotation = NumericConstant(string, location, value=Decimal("0.0"))

    return cls(
        string=string,
        location=location,
        exposure=exposure,
        diameter=diameter,
        center_x=center_x,
        center_y=center_y,
        rotation=rotation,
    )

evaluate 

evaluate(
    macro_context: MacroContext,
    state: State,
    handle: PrivateApertureHandle,
) -> None

Evaluate macro expression.

Source code in src\pygerber\gerberx3\tokenizer\tokens\macro\statements\code_1_circle.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def evaluate(
    self,
    macro_context: MacroContext,
    state: State,
    handle: PrivateApertureHandle,
) -> None:
    """Evaluate macro expression."""
    self.exposure.evaluate_numeric(macro_context, state)
    self.diameter.evaluate_numeric(macro_context, state)
    self.center_x.evaluate_numeric(macro_context, state)
    self.center_y.evaluate_numeric(macro_context, state)
    self.rotation.evaluate_numeric(macro_context, state)

    return super().evaluate(macro_context, state, handle)

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\macro\statements\code_1_circle.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().macro_code_1_circle.pre_parser_visit_token(
        self,
        context,
    )
    context.get_hooks().macro_code_1_circle.on_parser_visit_token(
        self,
        context,
    )
    context.get_hooks().macro_code_1_circle.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\macro\statements\code_1_circle.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",
) -> str:
    """Get gerber code represented by this token."""
    string = self.symbol

    string += f",{self.exposure.get_gerber_code(indent, endline)}"
    string += f",{self.diameter.get_gerber_code(indent, endline)}"
    string += f",{self.center_x.get_gerber_code(indent, endline)}"
    string += f",{self.center_y.get_gerber_code(indent, endline)}"

    if self.rotation is not None:
        string += f",{self.rotation.get_gerber_code(indent, endline)}"

    return indent + string