#include <Client.h>

Collaboration diagram for carla::client::Client:

Public Member Functions
void	ApplyBatch (std::vector< rpc::Command > commands, bool do_tick_cue=false) const

std::vector< rpc::CommandResponse >	ApplyBatchSync (std::vector< rpc::Command > commands, bool do_tick_cue=false) const

	Client (const std::string &host, uint16_t port, size_t worker_threads=0u)
	Construct a carla client. More...

World	GenerateOpenDriveWorld (std::string opendrive, const rpc::OpendriveGenerationParameters &params, bool reset_settings=true) const

std::vector< std::string >	GetAvailableMaps () const

std::string	GetClientVersion () const
	Return the version string of this client API. More...

carla::client::detail::EpisodeProxy	GetCurrentEpisode () const
	Return an instance of the Episode currently active in the simulator. More...

TrafficManager	GetInstanceTM (uint16_t port=TM_DEFAULT_PORT) const
	Return an instance of the TrafficManager currently active in the simulator. More...

std::vector< std::string >	GetRequiredFiles (const std::string &folder="", const bool download=true) const

std::string	GetServerVersion () const
	Return the version string of the simulator we are connected to. More...

time_duration	GetTimeout ()

World	GetWorld () const
	Return an instance of the world currently active in the simulator. More...

World	LoadWorld (std::string map_name, bool reset_settings=true, rpc::MapLayer map_layers=rpc::MapLayer::All) const

void	LoadWorldIfDifferent (std::string map_name, bool reset_settings=true, rpc::MapLayer map_layers=rpc::MapLayer::All) const
	Return (and load) a new world (map) only when the requested map is different from the current one. More...

World	ReloadWorld (bool reset_settings=true) const

std::string	ReplayFile (std::string name, double start, double duration, uint32_t follow_id, bool replay_sensors)

void	RequestFile (const std::string &name) const

bool	SetFilesBaseFolder (const std::string &path)

void	SetReplayerIgnoreHero (bool ignore_hero)

void	SetReplayerIgnoreSpectator (bool ignore_spectator)

void	SetReplayerTimeFactor (double time_factor)

void	SetTimeout (time_duration timeout)
	Set a timeout for networking operations. More...

std::string	ShowRecorderActorsBlocked (std::string name, double min_time, double min_distance)

std::string	ShowRecorderCollisions (std::string name, char type1, char type2)

std::string	ShowRecorderFileInfo (std::string name, bool show_all)

std::string	StartRecorder (std::string name, bool additional_data=false)

void	StopRecorder (void)

void	StopReplayer (bool keep_actors)

Private Attributes
std::shared_ptr< detail::Simulator >	_simulator

Detailed Description

Definition at line 20 of file client/Client.h.

Constructor & Destructor Documentation

◆ Client()

carla::client::Client::Client	(	const std::string &	host,
		uint16_t	port,
		size_t	worker_threads = `0u`
	)

inlineexplicit

Construct a carla client.

Parameters

host	IP address of the host machine running the simulator.
port	TCP port to connect with the simulator.
worker_threads	number of asynchronous threads to use, or 0 to use all available hardware concurrency.

Definition at line 183 of file client/Client.h.

Member Function Documentation

◆ ApplyBatch()

void carla::client::Client::ApplyBatch	(	std::vector< rpc::Command >	commands,
		bool	do_tick_cue = `false`
	)		const

inline

Definition at line 162 of file client/Client.h.

◆ ApplyBatchSync()

std::vector<rpc::CommandResponse> carla::client::Client::ApplyBatchSync	(	std::vector< rpc::Command >	commands,
		bool	do_tick_cue = `false`
	)		const

inline

Definition at line 168 of file client/Client.h.

◆ GenerateOpenDriveWorld()

World carla::client::Client::GenerateOpenDriveWorld	(	std::string	opendrive,
		const rpc::OpendriveGenerationParameters &	params,
		bool	reset_settings = `true`
	)		const

inline

Definition at line 98 of file client/Client.h.

◆ GetAvailableMaps()

std::vector<std::string> carla::client::Client::GetAvailableMaps ( ) const

inline

Definition at line 54 of file client/Client.h.

◆ GetClientVersion()

std::string carla::client::Client::GetClientVersion ( ) const

inline

Return the version string of this client API.

Definition at line 45 of file client/Client.h.

◆ GetCurrentEpisode()

carla::client::detail::EpisodeProxy carla::client::Client::GetCurrentEpisode ( ) const

inline

Return an instance of the Episode currently active in the simulator.

Definition at line 117 of file client/Client.h.

◆ GetInstanceTM()

TrafficManager carla::client::Client::GetInstanceTM ( uint16_t port = TM_DEFAULT_PORT ) const

inline

Return an instance of the TrafficManager currently active in the simulator.

Definition at line 112 of file client/Client.h.

◆ GetRequiredFiles()

std::vector<std::string> carla::client::Client::GetRequiredFiles	(	const std::string &	folder = `""`,
		const bool	download = `true`
	)		const

inline

Definition at line 62 of file client/Client.h.

◆ GetServerVersion()

std::string carla::client::Client::GetServerVersion ( ) const

inline

Return the version string of the simulator we are connected to.

Definition at line 50 of file client/Client.h.

◆ GetTimeout()

time_duration carla::client::Client::GetTimeout ( )

inline

Definition at line 40 of file client/Client.h.

◆ GetWorld()

World carla::client::Client::GetWorld ( ) const

inline

Return an instance of the world currently active in the simulator.

Definition at line 107 of file client/Client.h.

◆ LoadWorld()

World carla::client::Client::LoadWorld	(	std::string	map_name,
		bool	reset_settings = `true`,
		rpc::MapLayer	map_layers = `rpc::MapLayer::All`
	)		const

inline

Definition at line 74 of file client/Client.h.

◆ LoadWorldIfDifferent()

void carla::client::Client::LoadWorldIfDifferent	(	std::string	map_name,
		bool	reset_settings = `true`,
		rpc::MapLayer	map_layers = `rpc::MapLayer::All`
	)		const

inline

Return (and load) a new world (map) only when the requested map is different from the current one.

Definition at line 83 of file client/Client.h.

References carla::client::World::GetMap().

Here is the call graph for this function:

◆ ReloadWorld()

World carla::client::Client::ReloadWorld ( bool reset_settings = true ) const

inline

Definition at line 70 of file client/Client.h.

◆ ReplayFile()

std::string carla::client::Client::ReplayFile	(	std::string	name,
		double	start,
		double	duration,
		uint32_t	follow_id,
		bool	replay_sensors
	)

inline

Definition at line 141 of file client/Client.h.

◆ RequestFile()

void carla::client::Client::RequestFile ( const std::string & name ) const

inline

Definition at line 66 of file client/Client.h.

◆ SetFilesBaseFolder()

bool carla::client::Client::SetFilesBaseFolder ( const std::string & path )

inline

Definition at line 58 of file client/Client.h.

◆ SetReplayerIgnoreHero()

void carla::client::Client::SetReplayerIgnoreHero ( bool ignore_hero )

inline

Definition at line 154 of file client/Client.h.

◆ SetReplayerIgnoreSpectator()

void carla::client::Client::SetReplayerIgnoreSpectator ( bool ignore_spectator )

inline

Definition at line 158 of file client/Client.h.

◆ SetReplayerTimeFactor()

void carla::client::Client::SetReplayerTimeFactor ( double time_factor )

inline

Definition at line 150 of file client/Client.h.

◆ SetTimeout()

void carla::client::Client::SetTimeout ( time_duration timeout )

inline

Set a timeout for networking operations.

If set, any networking operation taking longer than timeout throws rpc::timeout.

Definition at line 36 of file client/Client.h.

◆ ShowRecorderActorsBlocked()

std::string carla::client::Client::ShowRecorderActorsBlocked	(	std::string	name,
		double	min_time,
		double	min_distance
	)

inline

Definition at line 137 of file client/Client.h.

◆ ShowRecorderCollisions()

std::string carla::client::Client::ShowRecorderCollisions	(	std::string	name,
		char	type1,
		char	type2
	)

inline

Definition at line 133 of file client/Client.h.

◆ ShowRecorderFileInfo()

std::string carla::client::Client::ShowRecorderFileInfo	(	std::string	name,
		bool	show_all
	)

inline

Definition at line 129 of file client/Client.h.

◆ StartRecorder()

std::string carla::client::Client::StartRecorder	(	std::string	name,
		bool	additional_data = `false`
	)

inline

Definition at line 121 of file client/Client.h.

◆ StopRecorder()

void carla::client::Client::StopRecorder ( void )

inline

Definition at line 125 of file client/Client.h.

◆ StopReplayer()

void carla::client::Client::StopReplayer ( bool keep_actors )

inline

Definition at line 146 of file client/Client.h.

Member Data Documentation

◆ _simulator

std::shared_ptr<detail::Simulator> carla::client::Client::_simulator

private

Definition at line 180 of file client/Client.h.

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

client/Client.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Client()

Member Function Documentation

◆ ApplyBatch()

◆ ApplyBatchSync()

◆ GenerateOpenDriveWorld()

◆ GetAvailableMaps()

◆ GetClientVersion()

◆ GetCurrentEpisode()

◆ GetInstanceTM()

◆ GetRequiredFiles()

◆ GetServerVersion()

◆ GetTimeout()

◆ GetWorld()

◆ LoadWorld()

◆ LoadWorldIfDifferent()

◆ ReloadWorld()

◆ ReplayFile()

◆ RequestFile()

◆ SetFilesBaseFolder()

◆ SetReplayerIgnoreHero()

◆ SetReplayerIgnoreSpectator()

◆ SetReplayerTimeFactor()

◆ SetTimeout()

◆ ShowRecorderActorsBlocked()

◆ ShowRecorderCollisions()

◆ ShowRecorderFileInfo()

◆ StartRecorder()

◆ StopRecorder()

◆ StopReplayer()

Member Data Documentation

◆ _simulator