port_drayage_plugin Namespace Reference

Classes
struct	Config
	Struct containing the algorithm configuration values for port_drayage_plugin. More...
struct	LatLonCoordinate
	Convenience struct for storing the vehicle's current latitude/longitude coordinates. More...
class	OperationID
	Helper class containing an enum for valid port drayage MobilityOperation message operation IDs and a function that converts each operation enum value to a human-readable string. More...
struct	PortDrayageMobilityOperationMsg
	Convenience struct for storing all data contained in a received MobilityOperation message's strategy_params field with strategy "carma/port_drayage". More...
class	PortDrayagePlugin
class	PortDrayageStateMachine
class	PortDrayageWorker

Enumerations
enum	PortDrayageState { INACTIVE , EN_ROUTE_TO_INITIAL_DESTINATION , EN_ROUTE_TO_RECEIVED_DESTINATION , AWAITING_DIRECTION }
	Enum containing the possible state values for the PortDrayagePlugin. More...
enum	PortDrayageEvent { DRAYAGE_START , RECEIVED_NEW_DESTINATION , ARRIVED_AT_DESTINATION , DRAYAGE_COMPLETED }
	Enum containing the event values that cause changes in the PortDrayagePlugin state machine. More...

Enumeration Type Documentation

PortDrayageEvent

enum port_drayage_plugin::PortDrayageEvent

Enum containing the event values that cause changes in the PortDrayagePlugin state machine.

DRAYAGE_START = Drayage operations have been commenced by the vehicle RECEIVED_NEW_DESTINATION = The port has commanded the vehicle to travel to a new destination. ARRIVED_AT_DESTINATION = The vehicle has arrived at it's destination. DRAYAGE_COMPLETED = The drayage operation is complete and the vehicle has exited the port area.

Enumerator
DRAYAGE_START
RECEIVED_NEW_DESTINATION
ARRIVED_AT_DESTINATION
DRAYAGE_COMPLETED

Definition at line 55 of file port_drayage_state_machine.hpp.

    {
        DRAYAGE_START,
        RECEIVED_NEW_DESTINATION,
        ARRIVED_AT_DESTINATION,
        DRAYAGE_COMPLETED
    };

PortDrayageState

enum port_drayage_plugin::PortDrayageState

Enum containing the possible state values for the PortDrayagePlugin.

INACTIVE = PortDrayagePlugin is not currently operating in an active capacity EN_ROUTE_TO_INITIAL_DESTINATION = The vehicle is currently enroute to its initial destination, the type of which is based on the configuration parameters for this node EN_ROUTE_TO_RECEIVED_DESTINATION = The vehicle is currently enroute to a destination that was received from infrastructure AWAITING_DIRECTION = The vehicle is currently stopped and is awaiting further guidance from the port infrastructure to tell it the next destination.

Enumerator
INACTIVE
EN_ROUTE_TO_INITIAL_DESTINATION
EN_ROUTE_TO_RECEIVED_DESTINATION
AWAITING_DIRECTION

Definition at line 36 of file port_drayage_state_machine.hpp.

    {
        INACTIVE,
        EN_ROUTE_TO_INITIAL_DESTINATION,
        EN_ROUTE_TO_RECEIVED_DESTINATION,
        AWAITING_DIRECTION
    };