ego_entity.hpp

Go to the documentation of this file.

// Copyright 2015 TIER IV, Inc. All rights reserved.
//
// 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 TRAFFIC_SIMULATOR__ENTITY__EGO_ENTITY_HPP_
#define TRAFFIC_SIMULATOR__ENTITY__EGO_ENTITY_HPP_
 
#include <algorithm>
#include <concealer/field_operator_application.hpp>
#include <filesystem>
#include <get_parameter/get_parameter.hpp>
#include <memory>
#include <optional>
#include <string>
#include <traffic_simulator/api/configuration.hpp>
#include <traffic_simulator/entity/vehicle_entity.hpp>
#include <traffic_simulator_msgs/msg/entity_type.hpp>
#include <vector>
 
namespace traffic_simulator
{
namespace entity
{
class EgoEntity : public VehicleEntity, private concealer::FieldOperatorApplication
{
  bool is_controlled_by_simulator_{false};
  std::optional<double> target_speed_;
  traffic_simulator_msgs::msg::BehaviorParameter behavior_parameter_;
  std::shared_ptr<traffic_simulator_msgs::msg::PolylineTrajectory> polyline_trajectory_;
 
public:
  explicit EgoEntity() = delete;
 
  explicit EgoEntity(
    const std::string & name, const CanonicalizedEntityStatus &,
    const traffic_simulator_msgs::msg::VehicleParameters &, const Configuration &,
    const rclcpp::node_interfaces::NodeParametersInterface::SharedPtr &);
 
  explicit EgoEntity(EgoEntity &&) = delete;
 
  explicit EgoEntity(const EgoEntity &) = delete;
 
  ~EgoEntity() override = default;
 
  auto operator=(EgoEntity &&) -> EgoEntity & = delete;
 
  auto operator=(const EgoEntity &) -> EgoEntity & = delete;
 
  auto getCurrentAction() const -> std::string override;
 
  auto getCurrentPose() const -> const geometry_msgs::msg::Pose &;
 
  auto getDefaultDynamicConstraints() const
    -> const traffic_simulator_msgs::msg::DynamicConstraints & override;
 
  auto getBehaviorParameter() const -> traffic_simulator_msgs::msg::BehaviorParameter override;
 
  auto getEntityStatus(const double, const double) const -> const CanonicalizedEntityStatus;
 
  auto getEntityTypename() const -> const std::string & override;
 
  auto getObstacle() -> std::optional<traffic_simulator_msgs::msg::Obstacle> override;
 
  auto getRouteLanelets(double horizon = 100) -> lanelet::Ids override;
 
  auto getWaypoints() -> const traffic_simulator_msgs::msg::WaypointsArray override;
 
  auto updateFieldOperatorApplication() -> void;
 
  void onUpdate(double current_time, double step_time) override;
 
  void requestAcquirePosition(const CanonicalizedLaneletPose &) override;
 
  void requestAcquirePosition(
    const CanonicalizedLaneletPose &, const traffic_simulator::RouteOption &) override;
 
  void requestAcquirePosition(const geometry_msgs::msg::Pose &) override;
 
  void requestAcquirePosition(
    const geometry_msgs::msg::Pose &, const traffic_simulator::RouteOption &) override;
 
  void requestAssignRoute(const std::vector<CanonicalizedLaneletPose> &) override;
 
  void requestAssignRoute(
    const std::vector<CanonicalizedLaneletPose> &, const traffic_simulator::RouteOption &) override;
 
  void requestAssignRoute(const std::vector<geometry_msgs::msg::Pose> &) override;
 
  void requestAssignRoute(
    const std::vector<geometry_msgs::msg::Pose> &, const traffic_simulator::RouteOption &) override;
 
  auto requestFollowTrajectory(
    const std::shared_ptr<traffic_simulator_msgs::msg::PolylineTrajectory> &) -> void override;
 
  auto requestLaneChange(const lanelet::Id) -> void override;
 
  auto requestLaneChange(const lane_change::Parameter &) -> void override;
 
  auto requestSpeedChange(
    const double, const speed_change::Transition, const speed_change::Constraint,
    const bool continuous) -> void override;
 
  auto requestSpeedChange(
    const speed_change::RelativeTargetSpeed &, const speed_change::Transition,
    const speed_change::Constraint, const bool continuous) -> void override;
 
  auto requestClearRoute() -> void;
 
  auto requestReplanRoute(
    const std::vector<geometry_msgs::msg::PoseStamped> & route,
    const bool allow_goal_modification = false) -> void;
 
  auto requestAutoModeForCooperation(const std::string & module_name, bool enable) -> void;
 
  auto isControlledBySimulator() const -> bool override;
 
  auto setControlledBySimulator(bool state) -> void override
  {
    is_controlled_by_simulator_ = state;
  }
 
  auto setBehaviorParameter(const traffic_simulator_msgs::msg::BehaviorParameter &)
    -> void override;
 
  void requestSpeedChange(double, bool continuous) override;
 
  void requestSpeedChange(
    const speed_change::RelativeTargetSpeed & target_speed, bool continuous) override;
 
  auto setVelocityLimit(double) -> void override;
 
  auto setMapPose(const geometry_msgs::msg::Pose & map_pose) -> void override;
 
  template <typename ParameterType>
  auto setParameter(const std::string & name, const ParameterType & default_value = {})
    -> ParameterType
  {
    return declare_parameter<ParameterType>(name, default_value);
  }
 
  template <typename... Ts>
  auto setStatus(Ts &&... xs) -> void
  {
    if (status_->getTime() > 0 && not isControlledBySimulator()) {
      THROW_SEMANTIC_ERROR(
        "You cannot set entity status to the ego vehicle named ", std::quoted(status_->getName()),
        " after starting scenario.");
    } else {
      EntityBase::setStatus(std::forward<decltype(xs)>(xs)...);
    }
  }
 
  auto engage() -> void;
  auto isEngaged() const -> bool;
  auto isEngageable() const -> bool;
  auto sendCooperateCommand(const std::string & module_name, const std::string & command) -> void;
  auto getMinimumRiskManeuverBehaviorName() const -> std::string;
  auto getMinimumRiskManeuverStateName() const -> std::string;
  auto getEmergencyStateName() const -> std::string;
  auto getTurnIndicatorsCommandName() const -> std::string;
};
}  // namespace entity
}  // namespace traffic_simulator
#endif  // TRAFFIC_SIMULATOR__ENTITY__EGO_ENTITY_HPP_