FacingMobility

Package: inet.mobility.single

FacingMobility

simple module

This module provides orientation towards the target mobility model as seen from the source mobility model.

Inheritance diagram

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

Extends

Name Type Description
MobilityBase 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)

initialX double uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
initialY double uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
initialZ double nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
initFromDisplayString bool true

enables one time initialization from the subject module's display string

sourceMobility string "."

the default source mobility is this

targetMobility string

Properties

Name Value Description
display i=block/cogwheel
class FacingMobility

Signals

Name Type Unit
mobilityStateChanged inet::MobilityBase

Direct method calls (observed)

call tofunctioninfo
SuperpositioningMobilityinet::SuperpositioningMobility::receiveSignalmobilityStateChanged

Source code

//
// This module provides orientation towards the target mobility model as seen
// from the source mobility model.
//
simple FacingMobility extends MobilityBase
{
    parameters:
        double initialX @unit(m) = default(uniform(this.constraintAreaMinX, this.constraintAreaMaxX));
        double initialY @unit(m) = default(uniform(this.constraintAreaMinY, this.constraintAreaMaxY));
        double initialZ @unit(m) = default(nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ)));
        bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string
        string sourceMobility = default("."); // the default source mobility is this
        string targetMobility @mutable;
        @class(FacingMobility);
}

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