launch.events package

Subpackages

• launch.events.process package
  • Submodules
    • launch.events.process.process_exited module
      • ProcessExited
    • launch.events.process.process_io module
      • ProcessIO
    • launch.events.process.process_matchers module
      • matches_executable()
      • matches_name()
      • matches_pid()
    • launch.events.process.process_started module
      • ProcessStarted
    • launch.events.process.process_stderr module
      • ProcessStderr
    • launch.events.process.process_stdin module
      • ProcessStdin
    • launch.events.process.process_stdout module
      • ProcessStdout
    • launch.events.process.process_targeted_event module
      • ProcessTargetedEvent
    • launch.events.process.running_process_event module
      • RunningProcessEvent
    • launch.events.process.shutdown_process module
      • ShutdownProcess
    • launch.events.process.signal_process module
      • SignalProcess
  • Module contents
    • ProcessExited
      • ProcessExited.__init__()
      • ProcessExited.name
      • ProcessExited.returncode
    • ProcessIO
      • ProcessIO.__init__()
      • ProcessIO.from_stderr
      • ProcessIO.from_stdin
      • ProcessIO.from_stdout
      • ProcessIO.name
      • ProcessIO.text
    • ProcessStarted
      • ProcessStarted.__init__()
      • ProcessStarted.name
    • ProcessStderr
      • ProcessStderr.__init__()
      • ProcessStderr.name
    • ProcessStdin
      • ProcessStdin.__init__()
      • ProcessStdin.name
    • ProcessStdout
      • ProcessStdout.__init__()
      • ProcessStdout.name
    • ProcessTargetedEvent
      • ProcessTargetedEvent.__init__()
      • ProcessTargetedEvent.name
      • ProcessTargetedEvent.process_matcher
    • RunningProcessEvent
      • RunningProcessEvent.__init__()
      • RunningProcessEvent.action
      • RunningProcessEvent.cmd
      • RunningProcessEvent.cwd
      • RunningProcessEvent.env
      • RunningProcessEvent.execute_process_action
      • RunningProcessEvent.name
      • RunningProcessEvent.pid
      • RunningProcessEvent.process_name
    • ShutdownProcess
      • ShutdownProcess.__init__()
      • ShutdownProcess.name
    • SignalProcess
      • SignalProcess.__init__()
      • SignalProcess.name
      • SignalProcess.signal
      • SignalProcess.signal_name
    • matches_executable()
    • matches_name()
    • matches_pid()

Submodules

• launch.events.execution_complete module
  • ExecutionComplete
    • ExecutionComplete.__init__()
    • ExecutionComplete.action
    • ExecutionComplete.name
• launch.events.include_launch_description module
  • IncludeLaunchDescription
    • IncludeLaunchDescription.__init__()
    • IncludeLaunchDescription.launch_description
    • IncludeLaunchDescription.name
• launch.events.matchers module
  • matches_action()
• launch.events.shutdown module
  • Shutdown
    • Shutdown.__init__()
    • Shutdown.due_to_sigint
    • Shutdown.name
    • Shutdown.reason
• launch.events.timer_event module
  • TimerEvent
    • TimerEvent.__init__()
    • TimerEvent.name
    • TimerEvent.timer_action

Module contents

Package for events.

class launch.events.ExecutionComplete

Bases: Event

Event that is emitted on action execution completion.

__init__(*, action: Action) → None

Create an ExecutionComplete event.

property action

Getter for action.

name = 'launch.events.ExecutionComplete'

class launch.events.IncludeLaunchDescription

Bases: Event

Event that can be emitted to cause a LaunchDescription to be included.

__init__(launch_description: LaunchDescription) → None

Create an IncludeLaunchDescription event.

property launch_description

Getter for launch_description.

name = 'launch.events.IncludeLaunchDescription'

class launch.events.Shutdown

Bases: Event

Event that is emitted on shutdown of a launched system.

__init__(*, reason: str = 'reason not given', due_to_sigint: bool = False) → None

Create a Shutdown event.

property due_to_sigint

Getter for due_to_sigint.

name = 'launch.events.Shutdown'

property reason

Getter for reason.

class launch.events.TimerEvent

Bases: Event

Event that fires when a TimerAction’s period expires.

__init__(*, timer_action: TimerAction) → None

Create a TimerEvent.

name = 'launch.events.TimerEvent'

property timer_action

Getter for timer_action.

launch.events.matches_action(target_action: Action) → Callable[[Action], bool]

Return a matcher which matches based on an exact given ExecuteProcess action.