Skip to content

in_image_name

in_image_name

Load Name (LN).

Note: The LN command was deprecated in revision I4 from October 2013.

The historic LN command doesn't influence the image in any manner and can safely be overlooked.

Function of the LN command: - LN is designed to allocate a name to the following section of the file. - It was originally conceptualized to serve as a human-readable comment. - For creating human-readable comments, it's advisable to utilize the standard G04 command. - The LN command has the flexibility to be executed multiple times within a file.

SPEC: 2023.03 SECTION: 8.1.6

ImageName

Bases: ExtendedCommandToken

Image Name (IN).

The IN command is deprecated since revision I4 from October 2013.

The historic IN command gives a name to the image contained in the Gerber file. The name must comply with the syntax rules for a string as described in section 3.4.3. This command can only be used once, at the beginning of the file.

IN has no effect on the image. A reader can ignore this command. The informal information provide by IN can also be put a G04 comment.

See section 8.1.3 of The Gerber Layer Format Specification Revision 2023.03 - https://argmaster.github.io/pygerber/latest/gerber_specification/revision_2023_03.html

Source code in src/pygerber/gerberx3/tokenizer/tokens/in_image_name.py 
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
class ImageName(ExtendedCommandToken):
    """### Image Name (IN).

    The IN command is deprecated since revision I4 from October 2013.

    The historic IN command gives a name to the image contained in the Gerber file.
    The name must comply with the syntax rules for a string as described in section
    3.4.3. This command can only be used once, at the beginning of the file.

    IN has no effect on the image. A reader can ignore this command. The informal
    information provide by IN can also be put a G04 comment.

    See section 8.1.3 of The Gerber Layer Format Specification Revision 2023.03 - https://argmaster.github.io/pygerber/latest/gerber_specification/revision_2023_03.html
    """

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

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

    def update_drawing_state(
        self,
        state: State,
        _backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Update drawing state."""
        warn_deprecated_code("IN", "8.1")
        return super().update_drawing_state(state, _backend)

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

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

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/in_image_name.py 
57
58
59
60
61
62
63
64
@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()`.
    """
    content: str = str(tokens["string"])
    return cls(string=string, location=location, content=content)

update_drawing_state 

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

Update drawing state.

Source code in src/pygerber/gerberx3/tokenizer/tokens/in_image_name.py 
66
67
68
69
70
71
72
73
def update_drawing_state(
    self,
    state: State,
    _backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Update drawing state."""
    warn_deprecated_code("IN", "8.1")
    return super().update_drawing_state(state, _backend)

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/in_image_name.py 
75
76
77
78
79
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().image_name.pre_parser_visit_token(self, context)
    context.get_hooks().image_name.on_parser_visit_token(self, context)
    context.get_hooks().image_name.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/in_image_name.py 
81
82
83
84
85
86
87
def get_gerber_code(
    self,
    indent: str = "",  # noqa: ARG002
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return f"IN{self.content}"