Skip to content

variable_name

variable_name

Macro variable use token.

MacroVariableName

Bases: MacroExpressionToken

4.5.4.1 Variable Values from the AD Command.

description

Example

%AMDONUTVAR*1,1,$1,$2,$3*1,0,$4,$2,$3*%
$1, $2, $3 and $4 are macro variables. With the following calling AD.

%ADD34DONUTVAR,0.100X0X0X0.080*%

the variables take the following values:

$1 = 0.100
$2 = 0
$3 = 0
$4 = 0.080

See section 4.5.4.1 of The Gerber Layer Format Specification

Source code in src\pygerber\gerberx3\tokenizer\tokens\macro\expressions\variable_name.py 
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
class MacroVariableName(MacroExpressionToken):
    """## 4.5.4.1 Variable Values from the AD Command.

    description

    ---

    ## Example

    ```gerber
    %AMDONUTVAR*1,1,$1,$2,$3*1,0,$4,$2,$3*%
    ```
    `$1`, `$2`, `$3` and `$4` are macro variables. With the following calling AD.

    ```gerber
    %ADD34DONUTVAR,0.100X0X0X0.080*%
    ```

    the variables take the following values:

    ```yaml
    $1 = 0.100
    $2 = 0
    $3 = 0
    $4 = 0.080
    ```

    ---

    See section 4.5.4.1 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=70)

    """

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

    @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()`.
        """
        name = str(tokens["macro_variable_name"])
        return cls(string=string, location=location, name=name)

    def to_parser2_expression(self, context: Parser2Context) -> Expression2:
        """Convert to `Expression2` descendant class."""
        return context.macro_expressions.variable_name(name=self.name)

    def evaluate_numeric(self, macro_context: MacroContext, _state: State) -> Offset:
        """Evaluate numeric value of this macro expression."""
        return macro_context.variables[self.name]

    def get_gerber_code(
        self,
        indent: str = "",  # noqa: ARG002
        endline: str = "\n",  # noqa: ARG002
    ) -> str:
        """Get gerber code represented by this token."""
        return self.name

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\expressions\variable_name.py 
59
60
61
62
63
64
65
66
@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()`.
    """
    name = str(tokens["macro_variable_name"])
    return cls(string=string, location=location, name=name)

to_parser2_expression 

to_parser2_expression(
    context: Parser2Context,
) -> Expression2

Convert to Expression2 descendant class.

Source code in src\pygerber\gerberx3\tokenizer\tokens\macro\expressions\variable_name.py 
68
69
70
def to_parser2_expression(self, context: Parser2Context) -> Expression2:
    """Convert to `Expression2` descendant class."""
    return context.macro_expressions.variable_name(name=self.name)

evaluate_numeric 

evaluate_numeric(
    macro_context: MacroContext, _state: State
) -> Offset

Evaluate numeric value of this macro expression.

Source code in src\pygerber\gerberx3\tokenizer\tokens\macro\expressions\variable_name.py 
72
73
74
def evaluate_numeric(self, macro_context: MacroContext, _state: State) -> Offset:
    """Evaluate numeric value of this macro expression."""
    return macro_context.variables[self.name]

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\expressions\variable_name.py 
76
77
78
79
80
81
82
def get_gerber_code(
    self,
    indent: str = "",  # noqa: ARG002
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return self.name