← Back to branch summary

~j-rivero/+junk/ignition-gazebo

« back to all changes in this revision

Viewing changes to src/network/NetworkRole.hh

  • Committer: Jose Luis Rivero
  • Date: 2022-02-15 17:35:59 UTC
  • Revision ID: jrivero@osrfoundation.org-20220215173559-qyu3wjmqnrby30k7
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/network/NetworkRole.hh
 
1
/*
 
2
 * Copyright (C) 2018 Open Source Robotics Foundation
 
3
 *
 
4
 * Licensed under the Apache License, Version 2.0 (the "License");
 
5
 * you may not use this file except in compliance with the License.
 
6
 * You may obtain a copy of the License at
 
7
 *
 
8
 *     http://www.apache.org/licenses/LICENSE-2.0
 
9
 *
 
10
 * Unless required by applicable law or agreed to in writing, software
 
11
 * distributed under the License is distributed on an "AS IS" BASIS,
 
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
13
 * See the License for the specific language governing permissions and
 
14
 * limitations under the License.
 
15
 *
 
16
 */
 
17
#ifndef IGNITION_GAZEBO_NETWORK_NETWORKROLE_HH_
 
18
#define IGNITION_GAZEBO_NETWORK_NETWORKROLE_HH_
 
19
 
 
20
#include <ignition/gazebo/config.hh>
 
21
#include <ignition/gazebo/Export.hh>
 
22
 
 
23
namespace ignition
 
24
{
 
25
  namespace gazebo
 
26
  {
 
27
    // Inline bracket to help doxygen filtering.
 
28
    inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
 
29
    /// \brief Enumeration of roles that a network participant can take.
 
30
    enum class NetworkRole
 
31
    {
 
32
      /// \brief participant has no role in the network
 
33
      None = 0,
 
34
      /// \brief participant is read-only, could potentially be used
 
35
      /// for visualization or logging, but is not executing simulation.
 
36
      ///
 
37
      /// This is reserved for future use.
 
38
      ReadOnly = 1,
 
39
      /// \brief participant is simulation primary, it is responsible for
 
40
      /// configuring simulation and assigning work to secondaries.
 
41
      ///
 
42
      /// There will be only one simulation primary in a given distributed
 
43
      /// simulation
 
44
      SimulationPrimary = 2,
 
45
      /// \brief participant is a simulation secondary, it receives work
 
46
      /// from the simulation primary and executes.
 
47
      SimulationSecondary = 3,
 
48
    };
 
49
    }
 
50
  }  // namespace gazebo
 
51
}  // namespace ignition
 
52
 
 
53
#endif  // IGNITION_GAZEBO_NETWORKROLE_HH_
 
54