Types.hh

Go to the documentation of this file.

/*
 * Copyright 2011 Nate Koenig
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef SDFORMAT_TYPES_HH_
#define SDFORMAT_TYPES_HH_
 
#include <algorithm>
#include <cmath>
#include <cstdint>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
 
#include <gz/utils/NeverDestroyed.hh>
#include <sdf/sdf_config.h>
#include "sdf/system_util.hh"
#include "sdf/Error.hh"
 
namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //
 
  constexpr std::string_view kScopeDelimiter{"::"};
 
  constexpr char kSdfStringSource[] = "<data-string>";
 
  constexpr char kUrdfStringSource[] = "<urdf-string>";
 
  SDFORMAT_VISIBLE
  std::vector<std::string> split(const std::string &_str,
                                 const std::string &_splitter);
 
  SDFORMAT_VISIBLE
  std::string trim(const char *_in);
 
  SDFORMAT_VISIBLE
  std::string trim(const std::string &_in);
 
  template<typename T>
  inline bool equal(const T &_a, const T &_b,
                    const T &_epsilon = 1e-6f)
  {
    return std::fabs(_a - _b) <= _epsilon;
  }
 
  using Errors = std::vector<Error>;
 
  SDFORMAT_VISIBLE std::ostream &operator<<(
      std::ostream &_out, const sdf::Errors &_errs);
 
  class SDFORMAT_VISIBLE Time
  {
    public: Time()
            : sec(0), nsec(0)
    {
    }
 
    public: Time(int32_t _sec, int32_t _nsec)
            : sec(_sec), nsec(_nsec)
    {
    }
 
    public: friend std::ostream &operator<<(std::ostream &_out,
                                            const Time &_time)
    {
      _out << _time.sec << " " << _time.nsec;
      return _out;
    }
 
    public: friend std::istream &operator>>(std::istream &_in,
                                            Time &_time)
    {
      // Skip white spaces
      _in.setf(std::ios_base::skipws);
      _in >> _time.sec >> _time.nsec;
      return _in;
    }
 
    public: bool operator ==(const Time &_time) const
    {
      return this->sec == _time.sec && this->nsec == _time.nsec;
    }
 
    public: int32_t sec;
 
    public: int32_t nsec;
  };
 
  std::string SDFORMAT_VISIBLE lowercase(const std::string &_in);
 
  SDFORMAT_VISIBLE
  std::pair<std::string, std::string> SplitName(
      const std::string &_absoluteName);
 
  SDFORMAT_VISIBLE
  std::string JoinName(
      const std::string &_scopeName, const std::string &_localName);
  }
}
#endif