carla::client Namespace Reference

Namespaces
namespace	detail

Classes
class	Actor
	Represents an actor in the simulation. More...
class	ActorAttribute
	An attribute of an ActorBlueprint. More...
class	ActorAttributeValue
class	ActorAttributeValueAccess
class	ActorBlueprint
	Contains all the necessary information for spawning an Actor. More...
class	ActorInitializer
	Used to initialize Actor classes. More...
class	ActorList
struct	ActorSnapshot
class	BadAttributeCast
	Exception thrown when the value of an ActorAttribute cannot be cast to the requested type. More...
class	BlueprintLibrary
class	Client
class	ClientSideSensor
class	DebugHelper
class	FileTransfer
class	InvalidAttributeValue
	Exception thrown when the value given to an ActorAttribute cannot be converted to its type. More...
class	Junction
class	Landmark
	Class containing a reference to RoadInfoSignal. More...
class	Lane
	A single OpenDRIVE lane, identified by (road id, lane section id, lane id). More...
class	LaneInvasionCallback
class	LaneInvasionSensor
class	LaneSection
	A stretch of road over which the lane layout does not change. More...
class	Light
class	LightManager
struct	LightState
class	Map
class	Road
	An OpenDRIVE road: a run of carriageway divided along s into lane sections, each holding the lanes. More...
class	RssSensor
	The RSS Sensor class implementing the carla::client::Sensor interface This class is a proxy to the RssCheck class. More...
class	Sensor
class	ServerSideSensor
class	TimeoutException
class	Timestamp
class	TrafficLight
class	TrafficSign
class	Vehicle
class	Walker
class	WalkerAIController
class	Waypoint
class	World
class	WorldSnapshot

Typedefs
using	Color = sensor::data::Color
using	LightGroup = rpc::LightState::LightGroup
using	LightId = uint32_t
using	Shape = rpc::DebugShape

Enumerations
enum class	GarbageCollectionPolicy { Disabled , Enabled , Inherit }

Functions
template<>
auto	ActorAttributeValueAccess::As< rpc::ActorAttributeType::Bool > () const
template<>
auto	ActorAttributeValueAccess::As< rpc::ActorAttributeType::Float > () const
template<>
auto	ActorAttributeValueAccess::As< rpc::ActorAttributeType::Int > () const
template<>
auto	ActorAttributeValueAccess::As< rpc::ActorAttributeType::RGBColor > () const
template<>
auto	ActorAttributeValueAccess::As< rpc::ActorAttributeType::String > () const
template<>
sensor::data::Color	ActorAttributeValueAccess::As< sensor::data::Color > () const
template<>
sensor::data::Color	ActorAttributeValueAccess::As< sensor::data::Color > () const
template<>
std::string	ActorAttributeValueAccess::As< std::string > () const
template<>
std::string	ActorAttributeValueAccess::As< std::string > () const
template<typename T >
static void	DrawShape (detail::EpisodeProxy &episode, const T &primitive, rpc::Color color, float life_time, bool persistent_lines)
template<typename Map , typename Container >
static void	FillMap (Map &destination, Container &source)
template<typename AttributesT >
static bool	GetControlIsSticky (const AttributesT &attributes)
const road::Road &	GetRoadData (const SharedPtr< const Map > &parent, road::RoadId road_id)
static double	JunctionSideDistance (const Lane &lane, bool entering)
static auto	MakeMap (const std::string &opendrive_contents)
template<typename EnumT >
static EnumT	operator& (EnumT lhs, EnumT rhs)
template<typename EnumT >
static EnumT	operator| (EnumT lhs, EnumT rhs)
static geom::Location	Rotate (float yaw, const geom::Location &location)
static fs::path	SanitizeRelativePath (std::string_view file)
static std::vector< const road::LaneSection * >	SectionsByDistance (const road::Road &road)
static road::LaneId	StepInward (road::LaneId lane_id)
static road::LaneId	StepOutward (road::LaneId lane_id)

Variables
static fs::path	CachePath

Typedef Documentation

Color

using carla::client::Color = typedef sensor::data::Color

Definition at line 15 of file client/LightState.h.

LightGroup

typedef rpc::LightState::LightGroup carla::client::LightGroup

Definition at line 16 of file Light.cpp.

LightId

using carla::client::LightId = typedef uint32_t

Definition at line 16 of file client/LightState.h.

Shape

using carla::client::Shape = typedef rpc::DebugShape

Definition at line 15 of file DebugHelper.cpp.

Enumeration Type Documentation

GarbageCollectionPolicy

enum class carla::client::GarbageCollectionPolicy

strong

Enumerator
Disabled
Enabled
Inherit

Definition at line 12 of file GarbageCollectionPolicy.h.

Function Documentation

ActorAttributeValueAccess::As< rpc::ActorAttributeType::Bool >()

template<>

auto carla::client::ActorAttributeValueAccess::As< rpc::ActorAttributeType::Bool > ( ) const

inline

Definition at line 105 of file LibCarla/source/carla/client/ActorAttribute.h.

Referenced by carla::client::ActorAttributeValueAccess::Validate().

ActorAttributeValueAccess::As< rpc::ActorAttributeType::Float >()

template<>

auto carla::client::ActorAttributeValueAccess::As< rpc::ActorAttributeType::Float > ( ) const

inline

Definition at line 115 of file LibCarla/source/carla/client/ActorAttribute.h.

Referenced by carla::client::ActorAttributeValueAccess::Validate().

ActorAttributeValueAccess::As< rpc::ActorAttributeType::Int >()

template<>

auto carla::client::ActorAttributeValueAccess::As< rpc::ActorAttributeType::Int > ( ) const

inline

Definition at line 110 of file LibCarla/source/carla/client/ActorAttribute.h.

Referenced by carla::client::ActorAttributeValueAccess::Validate().

ActorAttributeValueAccess::As< rpc::ActorAttributeType::RGBColor >()

template<>

auto carla::client::ActorAttributeValueAccess::As< rpc::ActorAttributeType::RGBColor > ( ) const

inline

Definition at line 125 of file LibCarla/source/carla/client/ActorAttribute.h.

References ActorAttributeValueAccess::As< sensor::data::Color >().

Referenced by carla::client::ActorAttributeValueAccess::Validate().

ActorAttributeValueAccess::As< rpc::ActorAttributeType::String >()

template<>

auto carla::client::ActorAttributeValueAccess::As< rpc::ActorAttributeType::String > ( ) const

inline

Definition at line 120 of file LibCarla/source/carla/client/ActorAttribute.h.

References ActorAttributeValueAccess::As< std::string >().

Referenced by carla::client::ActorAttributeValueAccess::Validate().

ActorAttributeValueAccess::As< sensor::data::Color >() [1/2]

template<>

sensor::data::Color carla::client::ActorAttributeValueAccess::As< sensor::data::Color >

(

)

const

Definition at line 70 of file ActorAttribute.cpp.

References LIBCARLA_THROW_BAD_VALUE_CAST, LIBCARLA_THROW_INVALID_VALUE, carla::log_error(), RGBColor, and carla::StringUtil::Split().

Referenced by ActorAttributeValueAccess::As< rpc::ActorAttributeType::RGBColor >().

ActorAttributeValueAccess::As< sensor::data::Color >() [2/2]

template<>

sensor::data::Color carla::client::ActorAttributeValueAccess::As< sensor::data::Color >

(

)

const

Definition at line 70 of file ActorAttribute.cpp.

References LIBCARLA_THROW_BAD_VALUE_CAST, LIBCARLA_THROW_INVALID_VALUE, carla::log_error(), RGBColor, and carla::StringUtil::Split().

Referenced by ActorAttributeValueAccess::As< rpc::ActorAttributeType::RGBColor >().

ActorAttributeValueAccess::As< std::string >() [1/2]

template<>

std::string carla::client::ActorAttributeValueAccess::As< std::string >

(

)

const

Definition at line 64 of file ActorAttribute.cpp.

References LIBCARLA_THROW_BAD_VALUE_CAST, and String.

Referenced by ActorAttributeValueAccess::As< rpc::ActorAttributeType::String >().

ActorAttributeValueAccess::As< std::string >() [2/2]

template<>

std::string carla::client::ActorAttributeValueAccess::As< std::string >

(

)

const

Definition at line 64 of file ActorAttribute.cpp.

References LIBCARLA_THROW_BAD_VALUE_CAST, and String.

Referenced by ActorAttributeValueAccess::As< rpc::ActorAttributeType::String >().

DrawShape()

template<typename T >

static void carla::client::DrawShape ( detail::EpisodeProxy &  episode, const T &  primitive, rpc::Color  color, float  life_time, bool  persistent_lines  )

static

Definition at line 18 of file DebugHelper.cpp.

References carla::client::detail::EpisodeProxyImpl< PointerT >::Lock().

Referenced by carla::client::DebugHelper::DrawArrow(), carla::client::DebugHelper::DrawBox(), carla::client::DebugHelper::DrawLine(), carla::client::DebugHelper::DrawPoint(), and carla::client::DebugHelper::DrawString().

FillMap()

template<typename Map , typename Container >

static void carla::client::FillMap ( Map &  destination, Container &  source  )

static

Definition at line 18 of file ActorBlueprint.cpp.

Referenced by carla::client::ActorBlueprint::ActorBlueprint().

GetControlIsSticky()

template<typename AttributesT >

static bool carla::client::GetControlIsSticky ( const AttributesT &  attributes )

static

Definition at line 25 of file Vehicle.cpp.

GetRoadData()

const road::Road & carla::client::GetRoadData	(	const SharedPtr< const Map > &	parent,
		road::RoadId	road_id
	)

Definition at line 25 of file client/Road.cpp.

References carla::road::Road::GetMap(), carla::road::MapData::GetRoad(), and road_id.

Referenced by carla::client::Road::GetJunctionId(), carla::client::Road::GetLanes(), carla::client::Road::GetLength(), carla::client::Road::GetName(), carla::client::Road::GetNextRoads(), carla::client::Road::GetPredecessorId(), carla::client::Road::GetPreviousRoads(), carla::client::Road::GetSectionAt(), carla::client::Road::GetSections(), carla::client::Road::GetSuccessorId(), carla::client::Road::GetTransformAt(), carla::client::Road::IsJunction(), and carla::client::Road::IsRHT().

JunctionSideDistance()

static double carla::client::JunctionSideDistance ( const Lane &  lane, bool  entering  )

static

Definition at line 123 of file Junction.cpp.

References carla::client::Lane::GetDistance(), carla::client::Lane::GetLength(), and carla::client::Lane::IsPositiveDirection().

Referenced by carla::client::Junction::GetNeighbourWaypoints().

MakeMap()

static auto carla::client::MakeMap ( const std::string &  opendrive_contents )

static

Definition at line 27 of file client/Map.cpp.

References carla::opendrive::OpenDriveParser::Load(), and carla::throw_exception().

operator&()

template<typename EnumT >

static EnumT carla::client::operator& ( EnumT  lhs, EnumT  rhs  )

static

Definition at line 177 of file client/Waypoint.cpp.

operator|()

template<typename EnumT >

static EnumT carla::client::operator| ( EnumT  lhs, EnumT  rhs  )

static

Definition at line 184 of file client/Waypoint.cpp.

Rotate()

static geom::Location carla::client::Rotate ( float  yaw, const geom::Location &  location  )

static

Definition at line 26 of file LibCarla/source/carla/client/LaneInvasionSensor.cpp.

References carla::geom::Vector3D::x, carla::geom::Vector3D::y, and carla::geom::Vector3D::z.

Referenced by carla::client::LaneInvasionCallback::MakeBounds().

SanitizeRelativePath()

static fs::path carla::client::SanitizeRelativePath ( std::string_view  file )

static

Definition at line 41 of file FileTransfer.cpp.

Referenced by carla::client::FileTransfer::FileExists(), carla::client::FileTransfer::ReadFile(), and carla::client::FileTransfer::WriteFile().

SectionsByDistance()

static std::vector< const road::LaneSection * > carla::client::SectionsByDistance ( const road::Road &  road )

static

Definition at line 23 of file client/LaneSection.cpp.

References road.

Referenced by carla::client::LaneSection::GetNextSection(), and carla::client::LaneSection::GetPreviousSection().

StepInward()

static road::LaneId carla::client::StepInward ( road::LaneId  lane_id )

static

Definition at line 31 of file client/Lane.cpp.

Referenced by carla::client::Lane::GetLeftLane(), and carla::client::Lane::GetRightLane().

StepOutward()

static road::LaneId carla::client::StepOutward ( road::LaneId  lane_id )

static

Definition at line 23 of file client/Lane.cpp.

Referenced by carla::client::Lane::GetLeftLane(), and carla::client::Lane::GetRightLane().

Variable Documentation

CachePath

fs::path carla::client::CachePath

static

Initial value:

= [] {
    constexpr char OverridePathEV[] = "CARLA_CACHE_DIR";
    constexpr char HomePathEV[] =
 
 
 
      "HOME";
 
    const char* override_path = std::getenv(OverridePathEV);
    if (override_path != NULL)
      return fs::path(override_path);
    fs::path path = std::getenv(HomePathEV);
    path /= "carlaCache";
    return fs::absolute(path);
  }()

Definition at line 17 of file FileTransfer.cpp.

Referenced by carla::client::FileTransfer::FileExists(), carla::client::FileTransfer::GetFilesBaseFolder(), carla::client::FileTransfer::ReadFile(), carla::client::FileTransfer::SetFilesBaseFolder(), and carla::client::FileTransfer::WriteFile().