inet::RectangleMobility Class Reference

Rectangle movement model. More...

#include <RectangleMobility.h>

Inheritance diagram for inet::RectangleMobility:

Public Member Functions
virtual double	getMaxSpeed () const override
	Returns the maximum possible speed at any future time. More...
	RectangleMobility ()
Public Member Functions inherited from inet::MovingMobilityBase
virtual Coord	getCurrentPosition () override
	Returns the current position at the current simulation time. More...
virtual Coord	getCurrentSpeed () override
	Returns the current speed at the current simulation time. More...
virtual EulerAngles	getCurrentAngularPosition () override
	Returns the current angular position at the current simulation time. More...
Public Member Functions inherited from inet::MobilityBase
virtual EulerAngles	getCurrentAngularSpeed () override
	Returns the current angular speed at the current simulation time. More...
virtual Coord	getConstraintAreaMax () const override
	Returns the current angular acceleration at the current simulation time. More...
virtual Coord	getConstraintAreaMin () const override
Public Member Functions inherited from inet::IMobility
virtual	~IMobility ()

Protected Member Functions
virtual int	numInitStages () const override
	Returns the required number of initialize stages. More...
virtual void	initialize (int stage) override
	Initializes mobility model parameters. More...
virtual void	setInitialPosition () override
	Initializes the position according to the mobility model. More...
virtual void	move () override
	Move the host. More...
Protected Member Functions inherited from inet::MovingMobilityBase
	MovingMobilityBase ()
virtual	~MovingMobilityBase ()
virtual void	initializePosition () override
	Initializes mobility position. More...
virtual void	handleSelfMessage (cMessage *message) override
	Called upon arrival of a self messages, subclasses must override. More...
void	scheduleUpdate ()
	Schedules the move timer that will update the mobility state. More...
void	moveAndUpdate ()
	Moves and notifies listeners. More...
Protected Member Functions inherited from inet::MobilityBase
	MobilityBase ()
virtual void	checkPosition ()
	Checks whether the position is valid or not. More...
virtual void	initializeOrientation ()
	Initializes the orientation from module parameters. More...
virtual void	handleMessage (cMessage *msg) override
	This modules should only receive self-messages. More...
virtual void	updateVisualRepresentation ()
	Moves the visual representation module's icon to the new position on the screen. More...
virtual void	emitMobilityStateChangedSignal ()
	Emits a signal with the updated mobility state. More...
virtual Coord	getRandomPosition ()
	Returns a new random position satisfying the constraint area. More...
virtual cModule *	findVisualRepresentation ()
	Returns the module that represents the object moved by this mobility module. More...
virtual bool	isOutside ()
	Returns true if the mobility is outside of the constraint area. More...
virtual void	reflectIfOutside (Coord &targetPosition, Coord &speed, double &angle)
	Utility function to reflect the node if it goes outside the constraint area. More...
virtual void	wrapIfOutside (Coord &targetPosition)
	Utility function to wrap the node to the opposite edge (torus) if it goes outside the constraint area. More...
virtual void	placeRandomlyIfOutside (Coord &targetPosition)
	Utility function to place the node randomly if it goes outside the constraint area. More...
virtual void	raiseErrorIfOutside ()
	Utility function to raise an error if the node gets outside the constraint area. More...
virtual void	handleIfOutside (BorderPolicy policy, Coord &targetPosition, Coord &speed, double &angle)
	Invokes one of reflectIfOutside(), wrapIfOutside() and placeRandomlyIfOutside(), depending on the given border policy. More...

Protected Attributes
double	speed
	speed of the host More...
double	d
	distance from (x1,y1), measured clockwise on the perimeter More...
double	corner1
double	corner2
double	corner3
double	corner4
Protected Attributes inherited from inet::MovingMobilityBase
cMessage *	moveTimer
	The message used for mobility state changes. More...
simtime_t	updateInterval
	The simulation time interval used to regularly signal mobility state changes. More...
bool	stationary
	A mobility model may decide to become stationary at any time. More...
Coord	lastSpeed
	The last speed that was reported at lastUpdate. More...
simtime_t	lastUpdate
	The simulation time when the mobility state was last updated. More...
simtime_t	nextChange
	The next simulation time when the mobility module needs to update its internal state. More...
Protected Attributes inherited from inet::MobilityBase
cModule *	visualRepresentation
	Pointer to visual representation module, to speed up repeated access. More...
const CanvasProjection *	canvasProjection
	The 2D projection used on the canvas. More...
Coord	constraintAreaMin
	3 dimensional position and size of the constraint area (in meters). More...
Coord	constraintAreaMax
Coord	lastPosition
	The last position that was reported. More...
EulerAngles	lastOrientation
	The last position that was reported. More...

Additional Inherited Members
Public Types inherited from inet::MobilityBase
enum	BorderPolicy { REFLECT, WRAP, PLACERANDOMLY, RAISEERROR }
	Selects how a mobility module should behave if it reaches the edge of the constraint area. More...
Static Public Attributes inherited from inet::IMobility
static simsignal_t	mobilityStateChangedSignal = cComponent::registerSignal("mobilityStateChanged")
	A signal used to publish mobility state changes. More...

Detailed Description

Rectangle movement model.

See NED file for more info.

Author

Andras Varga

Constructor & Destructor Documentation

inet::RectangleMobility::RectangleMobility

(

)

{
    speed = 0;
    d = 0;
    corner1 = corner2 = corner3 = corner4 = 0;
}

Member Function Documentation

virtual double inet::RectangleMobility::getMaxSpeed ( ) const

inlineoverridevirtual

Returns the maximum possible speed at any future time.

Reimplemented from inet::MobilityBase.

{ return speed; }

void inet::RectangleMobility::initialize ( int  stage )

overrideprotectedvirtual

Initializes mobility model parameters.

If the host is not stationary it calculates a random position on the rectangle.

Reimplemented from inet::MovingMobilityBase.

{
    MovingMobilityBase::initialize(stage);

    EV_TRACE << "initializing RectangleMobility stage " << stage << endl;
    if (stage == INITSTAGE_LOCAL) {
        speed = par("speed");
        stationary = (speed == 0);

        // calculate helper variables
        double dx = constraintAreaMax.x - constraintAreaMin.x;
        double dy = constraintAreaMax.y - constraintAreaMin.y;
        corner1 = dx;
        corner2 = corner1 + dy;
        corner3 = corner2 + dx;
        corner4 = corner3 + dy;

        // determine start position
        double startPos = par("startPos");
        startPos = fmod(startPos, 4);
        if (startPos < 1)
            d = startPos * dx; // top side
        else if (startPos < 2)
            d = corner1 + (startPos - 1) * dy; // right side
        else if (startPos < 3)
            d = corner2 + (startPos - 2) * dx; // bottom side
        else
            d = corner3 + (startPos - 3) * dy; // left side
        WATCH(d);
    }
}

void inet::RectangleMobility::move ( )

overrideprotectedvirtual

Move the host.

Implements inet::MovingMobilityBase.

Referenced by setInitialPosition().

{
    double elapsedTime = (simTime() - lastUpdate).dbl();
    d += speed * elapsedTime;

    while (d < 0)
        d += corner4;

    while (d >= corner4)
        d -= corner4;

    if (d < corner1) {
        // top side
        lastPosition.x = constraintAreaMin.x + d;
        lastPosition.y = constraintAreaMin.y;
        lastSpeed = Coord(speed, 0, 0);
    }
    else if (d < corner2) {
        // right side
        lastPosition.x = constraintAreaMax.x;
        lastPosition.y = constraintAreaMin.y + d - corner1;
        lastSpeed = Coord(0, speed, 0);
    }
    else if (d < corner3) {
        // bottom side
        lastPosition.x = constraintAreaMax.x - d + corner2;
        lastPosition.y = constraintAreaMax.y;
        lastSpeed = Coord(-speed, 0, 0);
    }
    else {
        // left side
        lastPosition.x = constraintAreaMin.x;
        lastPosition.y = constraintAreaMax.y - d + corner3;
        lastSpeed = Coord(0, -speed, 0);
    }
}

virtual int inet::RectangleMobility::numInitStages ( ) const

inlineoverrideprotectedvirtual

Returns the required number of initialize stages.

Reimplemented from inet::MobilityBase.

{ return NUM_INIT_STAGES; }

void inet::RectangleMobility::setInitialPosition ( )

overrideprotectedvirtual

Initializes the position according to the mobility model.

Reimplemented from inet::MobilityBase.

{
    MovingMobilityBase::setInitialPosition();
    move();
}

Member Data Documentation

double inet::RectangleMobility::corner1

protected

Referenced by initialize(), move(), and RectangleMobility().

double inet::RectangleMobility::corner2

protected

Referenced by initialize(), move(), and RectangleMobility().

double inet::RectangleMobility::corner3

protected

Referenced by initialize(), move(), and RectangleMobility().

double inet::RectangleMobility::corner4

protected

Referenced by initialize(), move(), and RectangleMobility().

double inet::RectangleMobility::d

protected

distance from (x1,y1), measured clockwise on the perimeter

Referenced by initialize(), move(), and RectangleMobility().

double inet::RectangleMobility::speed

protected

speed of the host

Referenced by initialize(), move(), and RectangleMobility().

---

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

• RectangleMobility.h
• RectangleMobility.cc