Ignition Gazebo

API Reference

3.0.0
System Class Reference

Base class for a System. More...

#include <ignition/gazebo/System.hh>

Public Member Functions

 System ()
 Constructor. More...
 
virtual ~System ()
 Destructor. More...
 

Detailed Description

Base class for a System.

A System operates on Entities that have certain Components. A System will only operate on an Entity if it has all of the required Components.

Systems are executed in three phases:

  • PreUpdate
    • Has read-write access to world entities and components
    • Executed with simulation time at (t0)
    • Can be used to modify state before physics runs, for example for applying control signals or performing network syncronization.
  • Update
    • Has read-write access to world entities and components
    • Responsible for propagating time from (t0) to (t0 + dt)
    • Used for physics simulation step
  • PostUpdate
    • Has read-only access to world entities and components
    • Executed with simulation time at (t0 + dt)
    • Used to read out results at the end of a simulation step to be used for sensor or controller updates.

Constructor & Destructor Documentation

◆ System()

System ( )

Constructor.

◆ ~System()

virtual ~System ( )
virtual

Destructor.


The documentation for this class was generated from the following file: