"""Define a useless command to serve as place holder."""
import logging
from lightwin.core.commands.command import Command
from lightwin.core.instruction import Instruction
from lightwin.tracewin_utils.line import DatLine
[docs]
class DummyCommand(Command):
"""Dummy class."""
is_implemented = False
[docs]
def __init__(
self, line: DatLine, dat_idx: int | None = None, **kwargs: str
) -> None:
"""Instantiate the dummy command."""
super().__init__(line, dat_idx, **kwargs)
[docs]
def set_influenced_elements(
self, instructions: list[Instruction], **kwargs: float
) -> None:
"""Determine the index of the elements concerned by :func:`apply`."""
return
[docs]
def apply(
self, instructions: list[Instruction], **kwargs: float
) -> list[Instruction]:
"""Do nothing."""
logging.error("DummyElement not implemented.")
return instructions
[docs]
def concerns_one_of(self, dat_indexes: list[int]) -> bool:
"""Tell if ``self`` concerns an element, which ``dat_idx`` is given.
Internally, we convert the ``self.influenced`` from a :class:`set` to
a :class:`list` object and check intersections with ``dat_indexes``.
Parameters
----------
dat_indexes :
Indexes in the ``DAT`` file of the sub-list of elements under
creation.
"""
return False