INET Framework for OMNeT++/OMNEST
inet::StaticGridMobility Class Reference

Mobility model which places all hosts at constant distances within the simulation area (resulting in a regular grid). More...

#include <StaticGridMobility.h>

Inheritance diagram for inet::StaticGridMobility:
inet::StationaryMobility inet::MobilityBase inet::IMobility

Public Member Functions

 StaticGridMobility ()
 
- Public Member Functions inherited from inet::StationaryMobility
 StationaryMobility ()
 
 StationaryMobility (Coord position)
 
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 double getMaxSpeed () const override
 Returns the maximum possible speed at any future 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::MobilityBase
virtual EulerAngles getCurrentAngularPosition () override
 Returns the current acceleration at the current simulation time. More...
 
virtual EulerAngles getCurrentAngularSpeed () override
 Returns the current angular speed at the current simulation time. More...
 
- Public Member Functions inherited from inet::IMobility
virtual ~IMobility ()
 

Protected Member Functions

virtual void setInitialPosition () override
 Initializes the position according to the mobility model. More...
 
- Protected Member Functions inherited from inet::StationaryMobility
virtual void handleSelfMessage (cMessage *message) override
 Never happens. More...
 
- Protected Member Functions inherited from inet::MobilityBase
 MobilityBase ()
 
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 initializePosition ()
 Initializes mobility position. More...
 
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...
 

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...
 
- Protected Attributes inherited from inet::MobilityBase
cModule * visualRepresentation
 Pointer to visual representation module, to speed up repeated access. More...
 
const CanvasProjectioncanvasProjection
 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...
 

Detailed Description

Mobility model which places all hosts at constant distances within the simulation area (resulting in a regular grid).

Author
Isabel Dietrich

Constructor & Destructor Documentation

inet::StaticGridMobility::StaticGridMobility ( )
inline
42 {};

Member Function Documentation

void inet::StaticGridMobility::setInitialPosition ( )
overrideprotectedvirtual

Initializes the position according to the mobility model.

Reimplemented from inet::MobilityBase.

27 {
28  int numHosts = par("numHosts");
29  double marginX = par("marginX");
30  double marginY = par("marginY");
31  double separationX = par("separationX");
32  double separationY = par("separationY");
33  int columns = par("columns");
34  int rows = par("rows");
35  if (numHosts > rows * columns)
36  throw cRuntimeError("parameter error: numHosts > rows * columns");
37 
38  int index = visualRepresentation->getIndex();
39 
40  int row = index / columns;
41  int col = index % columns;
42  lastPosition.x = constraintAreaMin.x + marginX + (col + 0.5) * separationX;
43  lastPosition.y = constraintAreaMin.y + marginY + (row + 0.5) * separationY;
44  lastPosition.z = par("initialZ");
45  recordScalar("x", lastPosition.x);
46  recordScalar("y", lastPosition.y);
47  recordScalar("z", lastPosition.z);
48 }
cModule * visualRepresentation
Pointer to visual representation module, to speed up repeated access.
Definition: MobilityBase.h:69
double z
Definition: Coord.h:51
Coord lastPosition
The last position that was reported.
Definition: MobilityBase.h:78
Coord constraintAreaMin
3 dimensional position and size of the constraint area (in meters).
Definition: MobilityBase.h:75
double y
Definition: Coord.h:50
double x
Definition: Coord.h:49

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