Error.hh

Go to the documentation of this file.

/*
 * Copyright 2017 Open Source Robotics Foundation
 *
 * 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 SDF_ERROR_HH_
#define SDF_ERROR_HH_
 
#include <optional>
#include <ostream>
#include <string>
#include <gz/utils/ImplPtr.hh>
#include <sdf/config.hh>
#include "sdf/Console.hh"
#include "sdf/system_util.hh"
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::string
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
 
namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //

  enum class ErrorCode
  {
    NONE = 0,

    FILE_READ,

    DUPLICATE_NAME,

    RESERVED_NAME,

    ATTRIBUTE_MISSING,

    ATTRIBUTE_INVALID,

    ATTRIBUTE_DEPRECATED,

    ATTRIBUTE_INCORRECT_TYPE,

    ELEMENT_MISSING,

    ELEMENT_INVALID,

    ELEMENT_DEPRECATED,

    ELEMENT_INCORRECT_TYPE,

    ELEMENT_ERROR,

    URI_INVALID,

    URI_LOOKUP,

    DIRECTORY_NONEXISTANT,

    MODEL_CANONICAL_LINK_INVALID,

    MODEL_WITHOUT_LINK,

    NESTED_MODELS_UNSUPPORTED,

    LINK_INERTIA_INVALID,

    JOINT_CHILD_LINK_INVALID,

    JOINT_PARENT_LINK_INVALID,

    JOINT_PARENT_SAME_AS_CHILD,

    FRAME_ATTACHED_TO_INVALID,

    FRAME_ATTACHED_TO_CYCLE,

    FRAME_ATTACHED_TO_GRAPH_ERROR,

    POSE_RELATIVE_TO_INVALID,

    POSE_RELATIVE_TO_CYCLE,

    POSE_RELATIVE_TO_GRAPH_ERROR,

    ROTATION_SNAP_CONFIG_ERROR,

    STRING_READ,

    MODEL_PLACEMENT_FRAME_INVALID,

    VERSION_DEPRECATED,

    MERGE_INCLUDE_UNSUPPORTED,

    PARAMETER_ERROR,

    UNKNOWN_PARAMETER_TYPE,

    FATAL_ERROR,

    WARNING,

    JOINT_AXIS_EXPRESSED_IN_INVALID,

    CONVERSION_ERROR,

    PARSING_ERROR,

    JOINT_AXIS_MIMIC_INVALID,

    XML_ERROR,
  };
 
  class SDFORMAT_VISIBLE Error
  {
    public: Error();

    public: Error(const ErrorCode _code, const std::string &_message);

    public: Error(const ErrorCode _code, const std::string &_message,
                  const std::string &_filePath);

    public: Error(const ErrorCode _code, const std::string &_message,
                  const std::string &_filePath, int _lineNumber);

    public: ErrorCode Code() const;

    public: std::string Message() const;

    public: void SetMessage(const std::string &_message);

    public: std::optional<std::string> FilePath() const;

    public: void SetFilePath(const std::string &_filePath);

    public: std::optional<int> LineNumber() const;

    public: void SetLineNumber(int _lineNumber);

    public: std::optional<std::string> XmlPath() const;

    public: void SetXmlPath(const std::string &_xmlPath);

    public: explicit operator bool() const;

    public: bool operator==(const bool _value) const;

    public: friend SDFORMAT_VISIBLE std::ostream &operator<<(
        std::ostream &_out, const sdf::Error &_err);

    GZ_UTILS_IMPL_PTR(dataPtr)
  };

  namespace internal
  {
  void SDFORMAT_VISIBLE throwOrPrintError(sdf::Console::ConsoleStream &_out,
                                          const sdf::Error &_error);
  }  // namespace internal
  }  // namespace SDF_VERSION_NAMESPACE
}  // namespace sdf
#ifdef _WIN32
#pragma warning(pop)
#endif
 
 
#endif