def execute_reset_wr_ptr(self, cmd): # pragma: no cover
""" This command resets the current write pointer to the beginning \
of the memory region.
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("RESET_RW_PTR")
def execute_struct_elem(self, cmd): # pragma: no cover
""" This command adds an element to a structure.
Implements :py:obj:`~.STRUCT_ELEM`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("STRUCT_ELEM")
def execute_end_constructor(self, cmd): # pragma: no cover
""" This command ends the definition of a function.
Implements :py:obj:`~.END_CONSTRUCTOR`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("END_CONSTRUCTOR")
def execute_declare_rng(self, cmd): # pragma: no cover
""" This command declares a random number generator.
Implements :py:obj:`~.DECLARE_RNG`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("DECLARE_RNG")
def execute_logic_op(self, cmd): # pragma: no cover
""" This command performs a logical operation.
Implements :py:obj:`~.LOGIC_OP`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("LOGIC_OP")
def execute_random_dist(self, cmd): # pragma: no cover
""" This command defines a random disribution.
Implements :py:obj:`~.DECLARE_RANDOM_DIST`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("DECLARE_RANDOM_DIST")
def execute_write_array(self, cmd): # pragma: no cover
""" This command writes an array of values in the specified region.
Implements :py:obj:`~.WRITE_ARRAY`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("WRITE_ARRAY")
def execute_reference(self, cmd): # pragma: no cover
""" This command reserves a region and sets it to reference another
Implements :py:obj:`~.REFERENCE`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("REFERENCE")
def execute_end_if(self, cmd): # pragma: no cover
""" This command ends a conditional.
Implements :py:obj:`~.END_IF`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("ENDIF")
def execute_else(self, cmd): # pragma: no cover
""" This command handles the other branch of a conditional.
Implements :py:obj:`~.ELSE`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("ELSE")
def execute_free(self, cmd): # pragma: no cover
""" This command frees some memory.
Implements :py:obj:`~.FREE`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("FREE")
def execute_read_param(self, cmd): # pragma: no cover
""" This command extracts an element from a structure.
Implements :py:obj:`~.READ_PARAM`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("READ_PARAM")
def execute_print_struct(self, cmd): # pragma: no cover
""" This command prints a structure to the log.
Implements :py:obj:`~.PRINT_STRUCT`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("PRINT_STRUCT")
def execute_reformat(self, cmd): # pragma: no cover
""" This command is never generated!
Implements :py:obj:`~.REFORMAT`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("REFORMAT")
def execute_break_loop(self, cmd): # pragma: no cover
""" This command stops a loop early.
Implements :py:obj:`~.BREAK_LOOP`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("BREAK_LOOP")
def execute_write_param_component(self, cmd): # pragma: no cover
""" This command is never generated!
Implements :py:obj:`~.WRITE_PARAM_COMPONENT`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("WRITE_PARAM_COMPONENT")
def execute_write_param(self, cmd): # pragma: no cover
""" This command handles a single element of a structure.
Implements :py:obj:`~.WRITE_PARAM`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("WRITE_PARAM")
def execute_copy_struct(self, cmd): # pragma: no cover
""" This command copies a structure from one slot to another.
Implements :py:obj:`~.COPY_STRUCT`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("COPY_STRUCT")
def execute_end_spec(self, cmd): # pragma: no cover
""" This command marks the end of the specification program.
Implements :py:obj:`~.END_SPEC`
:param int cmd: the command which triggered the function call
:return: A special marker to signal the end.
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("END_SPEC")
def execute_get_random_rumber(self, cmd): # pragma: no cover
""" This command obtains a random number from a distribution.
Implements :py:obj:`~.GET_RANDOM_NUMBER`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("GET_RANDOM_NUMBER")
def execute_set_wr_ptr(self, cmd): # pragma: no cover
""" This command sets the current write pointer.
Implements :py:obj:`~.SET_WR_PTR`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("SET_WR_PTR")
def execute_reserve(self, cmd): # pragma: no cover
""" This command reserves a region and assigns some memory space \
to it.
Implements :py:obj:`~.RESERVE`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("RESERVE")
def execute_copy_param(self, cmd): # pragma: no cover
""" This command copies a field of a structure to another field of \
a possibly-different structure.
Implements :py:obj:`~.COPY_PARAM`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("COPY_PARAM")
def execute_align_wr_ptr(self, cmd): # pragma: no cover
""" This command moves the write pointer to be at the start of the \
next word if it isn't already at the start of a word.
Implements :py:obj:`~.ALIGN_WR_PTR`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("ALIGN_WR_PTR")
def execute_mv(self, cmd): # pragma: no cover
""" This command moves an immediate value to a register or copies the \
value of a register to another register.
Implements :py:obj:`~.MV`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("MV")
def execute_block_copy(self, cmd): # pragma: no cover
""" This command copies a block of memory from one location to \
another.
Implements :py:obj:`~.BLOCK_COPY`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("BLOCK_COPY")
def execute_switch_focus(self, cmd): # pragma: no cover
""" This command switches the focus to the desired, already allocated,\
memory region.
Implements :py:obj:`~.SWITCH_FOCUS`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("SWITCH_FOCUS")
def execute_break(self, cmd): # pragma: no cover
""" This command raises an exception to stop the execution of the \
data spec executor (DSE).
Implements :py:obj:`~.BREAK`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("BREAK")
def execute_write(self, cmd): # pragma: no cover
""" This command writes the given value in the specified region a\
number of times as identified by either a value in the command \
or a register value.
Implements :py:obj:`~.WRITE`
:param int cmd: the command which triggered the function call
:return: No value returned
:raise DataSpecificationSyntaxError:\
If there is an error in the command syntax
:raise UnimplementedDSECommandError:\
If the command is not implemented.
"""
raise UnimplementedDSECommandError("WRITE")