rompy.swan.components.lockup.STOP

pydantic model rompy.swan.components.lockup.STOP

End of commands.

STOP

This required command marks the end of the commands in the command file. Note that the command STOP may be the last command in the input file; any information in the input file beyond this command is ignored.

Examples

In [1]: from rompy.swan.components.lockup import STOP

In [2]: stop = STOP()

In [3]: print(stop.render())
STOP

Show JSON schema

{
   "title": "STOP",
   "description": "End of commands.\n\n.. code-block:: text\n\n    STOP\n\nThis required command marks the end of the commands in the command file. Note that\nthe command `STOP` may be the last command in the input file; any information in\nthe input file beyond this command is ignored.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.lockup import STOP\n    stop = STOP()\n    print(stop.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "stop",
         "description": "Model type discriminator",
         "enum": [
            "stop",
            "STOP"
         ],
         "title": "Model Type",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields:

• model_type (Literal['stop', 'STOP'])

field model_type: Literal['stop', 'STOP'] = 'stop'

Model type discriminator

cmd() → str

Command file string for this component.