Gazebo Common

API Reference

3.17.0
gz/common/MaterialDensity.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 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 GZ_COMMON_MATERIALDENSITY_HH_
18 #define GZ_COMMON_MATERIALDENSITY_HH_
19 
20 #include <string>
21 #include <limits>
22 #include <map>
23 #include <tuple>
24 #include "gz/common/Export.hh"
25 
26 namespace ignition
27 {
28  namespace common
29  {
31  class IGNITION_COMMON_VISIBLE MaterialDensity
32  {
36  public: enum class Type
37  {
41  BEGIN = 0,
42 
44  STYROFOAM = BEGIN,
45 
47  PINE,
48 
50  WOOD,
51 
53  OAK,
54 
56  ICE,
57 
59  WATER,
60 
62  PLASTIC,
63 
65  CONCRETE,
66 
68  ALUMINUM,
69 
72 
75 
77  IRON,
78 
80  BRASS,
81 
83  COPPER,
84 
86  TUNGSTEN,
87 
91  END
92  };
93 
96  public: static const std::map<Type, double> &Materials();
97 
102  public: static double Density(const std::string &_material);
103 
107  public: static double Density(const Type _material);
108 
117  public: static std::tuple<Type, double> Nearest(
118  const double _value,
119  const double _epsilon = std::numeric_limits<double>::max());
120 
127  public: static Type NearestMaterial(const double _value,
128  const double _epsilon = std::numeric_limits<double>::max());
129 
130 #ifdef _WIN32
131 // Disable warning C4251
132 #pragma warning(push)
133 #pragma warning(disable: 4251)
134 #endif
135  private: static std::map<Type, double> materials;
137 #ifdef _WIN32
138 #pragma warning(pop)
139 #endif
140  };
141  }
142 }
143 #endif
static double Density(const std::string &_material)
Return the density of the given material name, or -1 if the material is not found.
Forward declarations for the common classes.
STL class.
@ ALUMINUM
Aluminum, density = 2700.0 kg/m^3.
Encapsulates density types.
Definition: gz/common/MaterialDensity.hh:31
@ WATER
Water, density = 1000.0 kg/m^3.
@ PLASTIC
Plastic, density = 1175.0 kg/m^3.
static const std::map< Type, double > & Materials()
Accessor for retrieving density entries.
@ WOOD
Wood, density = 700.0 kg/m^3.
@ BRASS
Brass, density = 8600.0 kg/m^3.
@ OAK
Oak, density = 710.0 kg/m^3.
@ PINE
Pine, density = 373.0 kg/m^3.
@ STEEL_ALLOY
Steel alloy, density = 7600.0 kg/m^3.
@ TUNGSTEN
Tungsten, density = 19300.0 kg/m^3.
@ STYROFOAM
Styrofoam, density = 75.0 kg/m^3.
@ IRON
Iron, density = 7870.0 kg/m^3.
@ CONCRETE
Concrete, density = 2000.0 kg/m^3.
@ ICE
Ice, density = 916.0 kg/m^3.
static Type NearestMaterial(const double _value, const double _epsilon=std::numeric_limits< double >::max())
Return the material with the closest density value within _epsilon, or MATERIAL_TYPE_END if not found...
@ STEEL_STAINLESS
Stainless steel, density = 7800.0 kg/m^3.
@ COPPER
Copper, density = 8940.0 kg/m^3.
static std::tuple< Type, double > Nearest(const double _value, const double _epsilon=std::numeric_limits< double >::max())
Return the material with the closest density value within _epsilon, or MATERIAL_TYPE_END if not found...
Type
Types of materials. Source: https://en.wikipedia.org/wiki/Density.
Definition: gz/common/MaterialDensity.hh:36