apollo::planning::scenario::Scenario Class Reference

#include <scenario.h>

Inheritance diagram for apollo::planning::scenario::Scenario:

Collaboration diagram for apollo::planning::scenario::Scenario:

Public Types
enum	ScenarioStatus { STATUS_UNKNOWN = 0, STATUS_PROCESSING = 1, STATUS_DONE = 2 }

Public Member Functions
	Scenario (const ScenarioConfig &config, const ScenarioContext *context, const std::shared_ptr< DependencyInjector > &injector)
virtual	~Scenario ()=default
ScenarioConfig::ScenarioType	scenario_type () const
virtual std::unique_ptr< Stage >	CreateStage (const ScenarioConfig::StageConfig &stage_config, const std::shared_ptr< DependencyInjector > &injector)=0
virtual bool	IsTransferable (const Scenario &other_scenario, const Frame &frame)
virtual ScenarioStatus	Process (const common::TrajectoryPoint &planning_init_point, Frame *frame)
const ScenarioStatus &	GetStatus () const
const ScenarioConfig::StageType	GetStage () const
virtual void	Init ()
const std::string &	Name () const
const std::string &	GetMsg () const

Static Public Member Functions
static bool	LoadConfig (const std::string &config_file, ScenarioConfig *config)

Protected Attributes
ScenarioStatus	scenario_status_ = STATUS_UNKNOWN
std::unique_ptr< Stage >	current_stage_
ScenarioConfig	config_
std::unordered_map< ScenarioConfig::StageType, const ScenarioConfig::StageConfig *, std::hash< int > >	stage_config_map_
const ScenarioContext *	scenario_context_ = nullptr
std::string	name_
std::string	msg_
std::shared_ptr< DependencyInjector >	injector_

Member Enumeration Documentation

ScenarioStatus

enum apollo::planning::scenario::Scenario::ScenarioStatus

Enumerator
STATUS_UNKNOWN
STATUS_PROCESSING
STATUS_DONE

Constructor & Destructor Documentation

Scenario()

apollo::planning::scenario::Scenario::Scenario	(	const ScenarioConfig &	config,
		const ScenarioContext *	context,
		const std::shared_ptr< DependencyInjector > &	injector
	)

~Scenario()

virtual apollo::planning::scenario::Scenario::~Scenario ( )

virtualdefault

Member Function Documentation

CreateStage()

virtual std::unique_ptr<Stage> apollo::planning::scenario::Scenario::CreateStage ( const ScenarioConfig::StageConfig &  stage_config, const std::shared_ptr< DependencyInjector > &  injector  )

pure virtual

Each scenario should define its own stages object's creation scenario will call stage's Stage::Process function following a configured order, The return value of Stage::Process function determines the transition from one stage to another.

Implemented in apollo::planning::scenario::stop_sign::StopSignUnprotectedScenario, apollo::planning::scenario::traffic_light::TrafficLightUnprotectedRightTurnScenario, apollo::planning::scenario::yield_sign::YieldSignScenario, apollo::planning::scenario::valet_parking::ValetParkingScenario, apollo::planning::scenario::traffic_light::TrafficLightUnprotectedLeftTurnScenario, apollo::planning::scenario::traffic_light::TrafficLightProtectedScenario, apollo::planning::scenario::bare_intersection::BareIntersectionUnprotectedScenario, apollo::planning::scenario::lane_follow::LaneFollowScenario, apollo::planning::scenario::emergency_pull_over::EmergencyPullOverScenario, apollo::planning::scenario::emergency_stop::EmergencyStopScenario, apollo::planning::scenario::pull_over::PullOverScenario, apollo::planning::scenario::LearningModelSampleScenario, apollo::planning::scenario::park_and_go::ParkAndGoScenario, and apollo::planning::scenario::narrow_street_u_turn::NarrowStreetUTurnScenario.

GetMsg()

const std::string& apollo::planning::scenario::Scenario::GetMsg ( ) const

inline

GetStage()

const ScenarioConfig::StageType apollo::planning::scenario::Scenario::GetStage ( ) const

inline

GetStatus()

const ScenarioStatus& apollo::planning::scenario::Scenario::GetStatus ( ) const

inline

Init()

virtual void apollo::planning::scenario::Scenario::Init ( )

virtual

Reimplemented in apollo::planning::scenario::stop_sign::StopSignUnprotectedScenario, apollo::planning::scenario::traffic_light::TrafficLightUnprotectedRightTurnScenario, apollo::planning::scenario::yield_sign::YieldSignScenario, apollo::planning::scenario::valet_parking::ValetParkingScenario, apollo::planning::scenario::traffic_light::TrafficLightUnprotectedLeftTurnScenario, apollo::planning::scenario::traffic_light::TrafficLightProtectedScenario, apollo::planning::scenario::bare_intersection::BareIntersectionUnprotectedScenario, apollo::planning::scenario::emergency_pull_over::EmergencyPullOverScenario, apollo::planning::scenario::emergency_stop::EmergencyStopScenario, apollo::planning::scenario::pull_over::PullOverScenario, apollo::planning::scenario::LearningModelSampleScenario, and apollo::planning::scenario::park_and_go::ParkAndGoScenario.

IsTransferable()

virtual bool apollo::planning::scenario::Scenario::IsTransferable ( const Scenario &  other_scenario, const Frame &  frame  )

inlinevirtual

LoadConfig()

static bool apollo::planning::scenario::Scenario::LoadConfig ( const std::string &  config_file, ScenarioConfig *  config  )

static

Name()

const std::string& apollo::planning::scenario::Scenario::Name

(

)

const

Process()

virtual ScenarioStatus apollo::planning::scenario::Scenario::Process ( const common::TrajectoryPoint &  planning_init_point, Frame *  frame  )

virtual

scenario_type()

ScenarioConfig::ScenarioType apollo::planning::scenario::Scenario::scenario_type ( ) const

inline

Member Data Documentation

config_

ScenarioConfig apollo::planning::scenario::Scenario::config_

protected

current_stage_

std::unique_ptr<Stage> apollo::planning::scenario::Scenario::current_stage_

protected

injector_

std::shared_ptr<DependencyInjector> apollo::planning::scenario::Scenario::injector_

protected

msg_

std::string apollo::planning::scenario::Scenario::msg_

protected

name_

std::string apollo::planning::scenario::Scenario::name_

protected

scenario_context_

const ScenarioContext* apollo::planning::scenario::Scenario::scenario_context_ = nullptr

protected

scenario_status_

ScenarioStatus apollo::planning::scenario::Scenario::scenario_status_ = STATUS_UNKNOWN

protected

stage_config_map_

std::unordered_map<ScenarioConfig::StageType, const ScenarioConfig::StageConfig*, std::hash<int> > apollo::planning::scenario::Scenario::stage_config_map_

protected

---

The documentation for this class was generated from the following file:

• modules/planning/scenarios/scenario.h