"""Define a useless command to serve as place holder."""
import logging
from pathlib import Path
from lightwin.core.commands.command import Command
from lightwin.core.elements.field_maps.field_map import FieldMap
from lightwin.core.instruction import Instruction
from lightwin.tracewin_utils.line import DatLine
[docs]
class FieldMapPath(Command):
"""Used to get the base path of field maps."""
is_implemented = True
n_attributes = 1
[docs]
def __init__(
self,
line: DatLine,
dat_idx: int | None = None,
default_field_map_folder: Path | None = None,
**kwargs: str,
) -> None:
"""Save the given path as attribute."""
assert default_field_map_folder is not None
super().__init__(line, dat_idx, **kwargs)
path = Path(line.splitted[1])
self.path = path
if self.path.is_dir():
return
self.path = default_field_map_folder / path
if self.path.is_dir():
return
self.path = default_field_map_folder
if self.path.is_dir():
return
logging.critical(
f"The {path = } given in FIELD_MAP_PATH was not found."
)
[docs]
def set_influenced_elements(
self, instructions: list[Instruction], **kwargs: float
) -> None:
"""Determine the index of the elements concerned by :func:`apply`."""
start = self.idx["dat_idx"] + 1
stop = start
for instruction in instructions[start:]:
if isinstance(instruction, FieldMapPath):
self.influenced = slice(start, stop)
return
stop += 1
self.influenced = slice(start, stop)
[docs]
def apply(
self, instructions: list[Instruction], **kwargs: float
) -> list[Instruction]:
"""Set |FM| field folder up.
If another :class:`FieldMapPath` is found, we stop and this command
will be applied later.
"""
for instruction in instructions[self.influenced]:
if isinstance(instruction, FieldMap):
instruction.field_map_folder = self.path
return instructions