Gazebo Physics

API Reference

5.3.2
gz/physics/OperateOnSpecifiedData.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 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 
18 #ifndef GZ_PHYISCS_OPERATEONSPECIFIEDDATA_HH_
19 #define GZ_PHYISCS_OPERATEONSPECIFIEDDATA_HH_
20 
21 #include <string>
22 #include <unordered_set>
23 
26 
27 namespace ignition
28 {
29  namespace physics
30  {
51  template <typename Specification,
52  template<typename> class SpecFinder,
53  template<typename, typename, typename> class Operation,
54  class Performer>
56  {
80  public: template <typename CompositeType>
81  static void Operate(
82  Performer *_performer,
83  CompositeType &_data,
84  const DataStatusMask &_mask,
85  const bool _onlyCompile = false);
86 
87 
88  // -------------------- Private API -----------------------
89 
94 
97  private: template <typename Data, typename SubSpecification,
98  typename CompositeType>
99  static void SubOperate(
100  detail::type<Data>, detail::type<SubSpecification>,
101  Performer *_performer, CompositeType &_data,
102  const DataStatusMask &_mask,
103  History &_history);
104 
107  private: template <typename SubSpecification, typename CompositeType>
108  static void SubOperate(
109  detail::type<void>, detail::type<SubSpecification>,
110  Performer *_performer, CompositeType &_data,
111  const DataStatusMask &_mask,
112  History &_history);
113 
116  private: template <typename CompositeType>
117  static void SubOperate(
118  detail::type<void>, detail::type<void>,
119  Performer*, CompositeType&,
120  const DataStatusMask&,
121  History&);
122  };
123  }
124 }
125 
126 #include "gz/physics/detail/OperateOnSpecifiedData.hh"
127 
128 #endif
static void Operate(Performer *_performer, CompositeType &_data, const DataStatusMask &_mask, const bool _onlyCompile=false)
Operate is the recommended entry point for using OperateOnSpecifiedData. This can be given a performe...
This struct encodes criteria for CompositeData::DataStatus so that Read and Write operations can be d...
Definition: gz/physics/DataStatusMask.hh:33
OperateOnSpecifiedData allows us to statically analyze whether a class (Performer) can perform an ope...
Definition: gz/physics/OperateOnSpecifiedData.hh:55