AI Testing Simulator
Loading...
Searching...
No Matches
Entity.StartPathInfo Class Reference

Class representing information needed to start a route. More...

Public Member Functions

 StartPathInfo (Adversary vehicle, Waypoint waypoint, int distance=5, string type="Waypoint")
 Initializes a new instance of the StartPathInfo class with a waypoint type.
 
 StartPathInfo (Adversary vehicle, int time, string type="Time")
 Initializes a new instance of the StartPathInfo class with a time type (Time based Start).
 
 StartPathInfo (Adversary vehicle, Location location, int distance, Ego egoVehicle, string type="Ego")
 Initializes a new instance of the StartPathInfo class with the specified parameters and the "Ego" Type (For Ego Vehicle).
 
bool isTypeWaypoint ()
 returns true if the type of the start route information is "Waypoint".
 
bool isTypeTimeOrEgo ()
 returns true if the type of the start route information is "Time" or "Ego" (or not Waypoint)
 

Properties

Adversary Vehicle [get, set]
 
Location LocationCarla [get]
 
int Time [get, set]
 
int Distance [get, set]
 
Ego EgoVehicle [get]
 
string Type [get]
 

Detailed Description

Class representing information needed to start a route.

Constructor & Destructor Documentation

◆ StartPathInfo() [1/3]

Entity.StartPathInfo.StartPathInfo ( Adversary  vehicle,
Waypoint  waypoint,
int  distance = 5,
string  type = "Waypoint" 
)
inline

Initializes a new instance of the StartPathInfo class with a waypoint type.

Parameters
vehicleThe adversary vehicle that triggers the route start. (Distance based Start).
waypointThe waypoint location (of adversary vehicle) that triggers the route start.
distanceThe distance in meters to the vehicle must be lower than this value to trigger the route start. (default is 5).
typeThe type of start path information (Default is "Waypoint" and shouldn't be changed).

◆ StartPathInfo() [2/3]

Entity.StartPathInfo.StartPathInfo ( Adversary  vehicle,
int  time,
string  type = "Time" 
)
inline

Initializes a new instance of the StartPathInfo class with a time type (Time based Start).

Parameters
vehicleThis value is not used for the type "Time". It can be a dummy vehicle in this case.
timeThe time in seconds when the route should start.
typeThe type of start path information. (Default is "Time and shouldn't be changed").

◆ StartPathInfo() [3/3]

Entity.StartPathInfo.StartPathInfo ( Adversary  vehicle,
Location  location,
int  distance,
Ego  egoVehicle,
string  type = "Ego" 
)
inline

Initializes a new instance of the StartPathInfo class with the specified parameters and the "Ego" Type (For Ego Vehicle).

Parameters
vehicleThis value is not used for the type "Time". It can be a dummy vehicle in this case.
locationThe location the ego vehicle must reach to trigger the route start.
distanceThe distance in meters to the ego vehicle must be lower than this value to trigger the route start.
egoVehicleThe Ego vehicle that triggers the route start (Distance based).
typeThe type of start path information. (Default is "Ego" and shouldn't be changed).
Returns
A new instance of the StartPathInfo class.

Member Function Documentation

◆ isTypeTimeOrEgo()

bool Entity.StartPathInfo.isTypeTimeOrEgo ( )
inline

returns true if the type of the start route information is "Time" or "Ego" (or not Waypoint)

Returns
True if the type of the start route information is NOT "Waypoint", false otherwise.

◆ isTypeWaypoint()

bool Entity.StartPathInfo.isTypeWaypoint ( )
inline

returns true if the type of the start route information is "Waypoint".

Returns
True if the type of the start route information is "Waypoint", false otherwise.

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