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

Mobility model which places all hosts on concenctric circles. More...

#include <StaticConcentricMobility.h>

Inheritance diagram for inet::StaticConcentricMobility:
inet::StationaryMobilityBase inet::MobilityBase inet::IMobility

Public Member Functions

 StaticConcentricMobility ()
 
- Public Member Functions inherited from inet::StationaryMobilityBase
virtual const QuaterniongetCurrentAngularPosition () override
 Returns the angular position at the current simulation time. More...
 
virtual const QuaterniongetCurrentAngularVelocity () override
 Returns the angular velocity at the current simulation time. More...
 
virtual const QuaterniongetCurrentAngularAcceleration () override
 Returns the angular acceleration at the current simulation time. More...
 
virtual const CoordgetCurrentPosition () override
 Returns the position at the current simulation time. More...
 
virtual const CoordgetCurrentVelocity () override
 Returns the velocity at the current simulation time. More...
 
virtual const CoordgetCurrentAcceleration () override
 Returns the acceleration at the current simulation time. More...
 
virtual double getMaxSpeed () const override
 Returns the maximum possible speed at any future time. More...
 
virtual const CoordgetConstraintAreaMax () const override
 Returns the maximum position along each axes for. More...
 
virtual const CoordgetConstraintAreaMin () const override
 Returns the minimum position along each axes for. 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::StationaryMobilityBase
virtual void handleSelfMessage (cMessage *message) override
 Called upon arrival of a self messages, subclasses must override. More...
 
- Protected Member Functions inherited from inet::MobilityBase
 MobilityBase ()
 
virtual int getId () const override
 
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 refreshDisplay () const override
 Moves the visual representation module's icon to the new position on the screen. More...
 
virtual void updateDisplayStringFromMobilityState () const
 
virtual void handleParameterChange (const char *name) override
 Allows changing parameters from the GUI. More...
 
virtual void handleMessage (cMessage *msg) override
 This modules should only receive self-messages. 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 * findSubjectModule ()
 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 &velocity, rad &angle, rad &elevation, Quaternion &quaternion)
 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 &velocity)
 Invokes one of reflectIfOutside(), wrapIfOutside() and placeRandomlyIfOutside(), depending on the given border policy. More...
 
virtual void handleIfOutside (BorderPolicy policy, Coord &targetPosition, Coord &velocity, rad &heading)
 
virtual void handleIfOutside (BorderPolicy policy, Coord &targetPosition, Coord &velocity, rad &heading, rad &elevation)
 
virtual void handleIfOutside (BorderPolicy policy, Coord &targetPosition, Coord &velocity, rad &heading, rad &elevation, Quaternion &quaternion)
 

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 * subjectModule
 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...
 
Quaternion lastOrientation
 The last orientation that was reported. More...
 
StringFormat format
 

Detailed Description

Mobility model which places all hosts on concenctric circles.

Author
Florian Meier

Constructor & Destructor Documentation

◆ StaticConcentricMobility()

inet::StaticConcentricMobility::StaticConcentricMobility ( )
inline
29 {};

Member Function Documentation

◆ setInitialPosition()

void inet::StaticConcentricMobility::setInitialPosition ( )
overrideprotectedvirtual

Initializes the position according to the mobility model.

Reimplemented from inet::MobilityBase.

17 {
18  unsigned int numHosts = par("numHosts");
19  double distance = par("distance");
20 
21  unsigned int index = subjectModule->getIndex();
22 
23  unsigned int totalCircles = 0;
24  unsigned int totalNodesOnInnerCircles = 0;
25  unsigned int nodesOnThisCircle = 1;
26 
27  unsigned int myCircle = 0;
28  unsigned int nodesOnInnerCircles = 0;
29 
30  for (unsigned int i = 0; i < numHosts; i++) {
31  if (i - totalNodesOnInnerCircles >= nodesOnThisCircle) {
32  // start new circle
33  totalCircles++;
34  totalNodesOnInnerCircles += nodesOnThisCircle;
35  nodesOnThisCircle = (int)(2 * M_PI * totalCircles);
36  }
37 
38  if (i == index) {
39  myCircle = totalCircles;
40  nodesOnInnerCircles = totalNodesOnInnerCircles;
41  }
42  }
43 
44  lastPosition.x = distance * totalCircles;
45  lastPosition.y = distance * totalCircles;
46 
47  if (constraintAreaMin.x > -INFINITY) {
49  }
50 
51  if (constraintAreaMin.y > -INFINITY) {
53  }
54 
55  if (index > 0) {
56  double radius = distance * myCircle;
57  double angularStep = 2.0 * M_PI / (int)(2 * M_PI * myCircle);
58  double angle = angularStep * (index - nodesOnInnerCircles);
59  lastPosition.x += radius * cos(angle);
60  lastPosition.y += radius * sin(angle);
61  }
62 
63  lastPosition.z = par("initialZ");
64  recordScalar("x", lastPosition.x);
65  recordScalar("y", lastPosition.y);
66  recordScalar("z", lastPosition.z);
67 }

The documentation for this class was generated from the following files:
inet::MobilityBase::lastPosition
Coord lastPosition
The last position that was reported.
Definition: MobilityBase.h:73
inet::Coord::x
double x
Definition: Coord.h:36
inet::units::cos
Value cos(const value< Value, Unit > &angle)
Definition: Units.h:1524
INFINITY
#define INFINITY
Definition: Topology.h:20
inet::Coord::z
double z
Definition: Coord.h:38
inet::MobilityBase::subjectModule
cModule * subjectModule
Pointer to visual representation module, to speed up repeated access.
Definition: MobilityBase.h:64
inet::MobilityBase::constraintAreaMin
Coord constraintAreaMin
3 dimensional position and size of the constraint area (in meters).
Definition: MobilityBase.h:70
inet::Coord::y
double y
Definition: Coord.h:37
M_PI
#define M_PI
Definition: INETMath.h:52
inet::units::sin
Value sin(const value< Value, Unit > &angle)
Definition: Units.h:1518