Frame.hh

Go to the documentation of this file.

/*
 * Copyright 2019 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_FRAME_HH_
#define SDF_FRAME_HH_

#include <memory>
#include <string>
#include <ignition/math/Pose3.hh>
#include "sdf/Element.hh"
#include "sdf/SemanticPose.hh"
#include "sdf/Types.hh"
#include "sdf/sdf_config.h"
#include "sdf/system_util.hh"

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //
  // Forward declaration.
  class FramePrivate;
  struct FrameAttachedToGraph;
  struct PoseRelativeToGraph;

  class SDFORMAT_VISIBLE Frame
  {
    public: Frame();

    public: Frame(const Frame &_frame);

    public: Frame(Frame &&_frame);

    public: ~Frame();

    public: Frame &operator=(Frame &&_frame);

    public: Frame &operator=(const Frame &_frame);

    public: Errors Load(ElementPtr _sdf);

    public: const std::string &Name() const;

    public: void SetName(const std::string &_name) const;

    public: const std::string &AttachedTo() const;

    public: void SetAttachedTo(const std::string &_frame);

    public: const ignition::math::Pose3d &RawPose() const;

    public: void SetRawPose(const ignition::math::Pose3d &_pose);

    public: const std::string &PoseRelativeTo() const;

    public: void SetPoseRelativeTo(const std::string &_frame);

    public: sdf::ElementPtr Element() const;

    public: Errors ResolveAttachedToBody(std::string &_body) const;

    public: sdf::SemanticPose SemanticPose() const;

    private: void SetFrameAttachedToGraph(
        std::weak_ptr<const FrameAttachedToGraph> _graph);

    private: void SetPoseRelativeToGraph(
        std::weak_ptr<const PoseRelativeToGraph> _graph);

    friend class Model;
    friend class World;

    private: FramePrivate *dataPtr = nullptr;
  };
  }
}
#endif