openpectus.engine.internal_commands_impl

Attributes

logger

CANCEL_TIMEOUT_TICKS

Classes

StartEngineCommand

Base class for internal engine commands.

PauseEngineCommand

Pause execution of commands and time. Put output tags into safe state.

UnpauseEngineCommand

Base class for internal engine commands.

HoldEngineCommand

Hold execution of commands and time, keeping ouput tags in their current state.

UnholdEngineCommand

Base class for internal engine commands.

StopEngineCommand

Base class for internal engine commands.

RestartEngineCommand

Base class for internal engine commands.

InfoEngineCommand

Base class for internal engine commands.

WarningEngineCommand

Base class for internal engine commands.

ErrorEngineCommand

Base class for internal engine commands.

Module Contents

openpectus.engine.internal_commands_impl.logger
openpectus.engine.internal_commands_impl.CANCEL_TIMEOUT_TICKS = 10
class openpectus.engine.internal_commands_impl.StartEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.PauseEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Pause execution of commands and time. Put output tags into safe state.

See also Hold and Wait.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.UnpauseEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.HoldEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Hold execution of commands and time, keeping ouput tags in their current state.

See also Pause and Wait.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.UnholdEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.StopEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.RestartEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
engine
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.InfoEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.WarningEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).

class openpectus.engine.internal_commands_impl.ErrorEngineCommand(engine, registry)

Bases: openpectus.engine.internal_commands.InternalEngineCommand

Base class for internal engine commands.

Adds support for long-running commands via a _run() generator method. The tick() base class method implements the state management of these commands.

Parameters:
_run()

Override to implement the command using a generator style where each yield pauses execution until the next tick (i.e. call to execute()).