VehicleMobility

simple module

(no description)

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name	Type	Description
MovingMobilityBase	simple module	Abstract base module for mobility models.

Parameters

Name	Type	Default value	Description
subjectModule	string	"^"	module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
coordinateSystemModule	string	""	module path of the geographic coordinate system module
displayStringTextFormat	string	"p: %p\nv: %v"	format string for the mobility module's display string text
updateDisplayString	bool	true	enables continuous update of the subject module's position via modifying its display string
constraintAreaMinX	double	-inf m	min x position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMinY	double	-inf m	min y position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMinZ	double	-inf m	min z position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMaxX	double	inf m	max x position of the constraint area, unconstrained by default (positive infinity)
constraintAreaMaxY	double	inf m	max y position of the constraint area, unconstrained by default (positive infinity)
constraintAreaMaxZ	double	inf m	max z position of the constraint area, unconstrained by default (positive infinity)
updateInterval	double	0.1s	the simulation time interval used to regularly signal mobility state changes and update the display
faceForward	bool	true
waypointFile	string		contains the waypoints as one waypoint x,y,z per line
waypointProximity	double		a waypoint is reached when it is less than waypointProximity meters away
speed	double
groundModule	string	"environment.ground"	module path of the ground module
initialX	double	uniform(constraintAreaMinX, constraintAreaMaxX)
initialY	double	uniform(constraintAreaMinY, constraintAreaMaxY)
initialZ	double	nanToZero(uniform(constraintAreaMinZ, constraintAreaMaxZ))
initFromDisplayString	bool	true	enables one time initialization from the subject module's display string

Properties

Name	Value	Description
display	i=block/cogwheel
class	VehicleMobility

Signals

Name	Type	Unit
mobilityStateChanged	inet::MobilityBase

Scheduled messages (observed)

msg	kind	ctrl	tags	msgname	context
omnetpp::cMessage	0			move

Source code

simple VehicleMobility extends MovingMobilityBase
{
    parameters:
        @class(VehicleMobility);
        string waypointFile; // contains the waypoints as one waypoint x,y,z per line
        double waypointProximity @unit(m); // a waypoint is reached when it is less than waypointProximity meters away
        double speed @unit(mps);
        string groundModule = default("environment.ground"); // module path of the ground module
        double initialX @unit(m) = default(uniform(constraintAreaMinX, constraintAreaMaxX));
        double initialY @unit(m) = default(uniform(constraintAreaMinY, constraintAreaMaxY));
        double initialZ @unit(m) = default(nanToZero(uniform(constraintAreaMinZ, constraintAreaMaxZ)));
        bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string
}

File: src/inet/mobility/single/VehicleMobility.ned