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

Chiang's random walk movement model. More...

#include <ChiangMobility.h>

Inheritance diagram for inet::ChiangMobility:
inet::LineSegmentsMobilityBase inet::MovingMobilityBase inet::MobilityBase inet::IMobility

Public Member Functions

virtual double getMaxSpeed () const override
 Returns the maximum possible speed at any future time. More...
 
 ChiangMobility ()
 
- Public Member Functions inherited from inet::LineSegmentsMobilityBase
 LineSegmentsMobilityBase ()
 
- 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...
 
int getNextStateIndex (int currentState)
 Gets the next state based on the current state. More...
 
void setTargetPosition () override
 Calculate a new target position to move to. More...
 
virtual void move () override
 Move the host according to the current simulation time. More...
 
- Protected Member Functions inherited from inet::LineSegmentsMobilityBase
virtual void initializePosition () override
 Initializes mobility position. More...
 
- Protected Member Functions inherited from inet::MovingMobilityBase
 MovingMobilityBase ()
 
virtual ~MovingMobilityBase ()
 
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 setInitialPosition ()
 Initializes the position from the display string or from module parameters. 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...
 

Protected Attributes

double speed
 speed of the host More...
 
double stateTransitionUpdateInterval
 how often to calculate the new state More...
 
int xState
 0 = negative direction, 1 = no move, 2 = positive direction More...
 
int yState
 0 = negative direction, 1 = no move, 2 = positive direction More...
 
- Protected Attributes inherited from inet::LineSegmentsMobilityBase
Coord targetPosition
 End position of current linear movement. More...
 
- 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 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...
 

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

Chiang's random walk movement model.

See NED file for more info.

Author
Marcin Kosiba

Constructor & Destructor Documentation

inet::ChiangMobility::ChiangMobility ( )
33 {
34  speed = 0;
36  xState = 0;
37  yState = 0;
38 }
int yState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:38
int xState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:37
double speed
speed of the host
Definition: ChiangMobility.h:35
double stateTransitionUpdateInterval
how often to calculate the new state
Definition: ChiangMobility.h:36

Member Function Documentation

virtual double inet::ChiangMobility::getMaxSpeed ( ) const
inlineoverridevirtual

Returns the maximum possible speed at any future time.

Reimplemented from inet::MobilityBase.

56 { return speed; }
double speed
speed of the host
Definition: ChiangMobility.h:35
int inet::ChiangMobility::getNextStateIndex ( int  currentState)
protected

Gets the next state based on the current state.

Referenced by setTargetPosition().

55 {
56  //we assume that the sum in each row is 1
57  double sum = 0;
58  double randomValue = uniform(0.0, 1.0);
59  for (int i = 0; i < 3; i++) {
60  sum += stateMatrix[currentState][i];
61  if (sum >= randomValue)
62  return i;
63  }
64  EV_DEBUG << " getNextStateIndex error! currentState= " << currentState << " value= " << randomValue << endl;
65  return currentState;
66 }
void inet::ChiangMobility::initialize ( int  stage)
overrideprotectedvirtual

Initializes mobility model parameters.

Reimplemented from inet::MovingMobilityBase.

41 {
43 
44  EV_TRACE << "initializing ChiangMobility stage " << stage << endl;
45  if (stage == INITSTAGE_LOCAL) {
46  stateTransitionUpdateInterval = par("stateTransitionUpdateInterval");
47  speed = par("speed");
48  stationary = (speed == 0);
49  xState = 1;
50  yState = 1;
51  }
52 }
virtual void initialize(int stage) override
Initializes mobility model parameters.
Definition: MovingMobilityBase.cc:42
int yState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:38
int xState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:37
Local initializations.
Definition: InitStages.h:35
bool stationary
A mobility model may decide to become stationary at any time.
Definition: MovingMobilityBase.h:49
double speed
speed of the host
Definition: ChiangMobility.h:35
double stateTransitionUpdateInterval
how often to calculate the new state
Definition: ChiangMobility.h:36
void inet::ChiangMobility::move ( )
overrideprotectedvirtual

Move the host according to the current simulation time.

Reimplemented from inet::LineSegmentsMobilityBase.

83 {
85  double dummyAngle;
86  Coord dummyPosition;
87  handleIfOutside(REFLECT, dummyPosition, lastSpeed, dummyAngle);
88 }
reflect off the wall
Definition: MobilityBase.h:61
virtual void move() override
Moves according to the mobility model to the current simulation time.
Definition: LineSegmentsMobilityBase.cc:40
virtual void handleIfOutside(BorderPolicy policy, Coord &targetPosition, Coord &speed, double &angle)
Invokes one of reflectIfOutside(), wrapIfOutside() and placeRandomlyIfOutside(), depending on the giv...
Definition: MobilityBase.cc:269
Coord lastSpeed
The last speed that was reported at lastUpdate.
Definition: MovingMobilityBase.h:52
virtual int inet::ChiangMobility::numInitStages ( ) const
inlineoverrideprotectedvirtual

Returns the required number of initialize stages.

Reimplemented from inet::MobilityBase.

41 { return NUM_INIT_STAGES; }
The number of initialization stages.
Definition: InitStages.h:116
void inet::ChiangMobility::setTargetPosition ( )
overrideprotectedvirtual

Calculate a new target position to move to.

Implements inet::LineSegmentsMobilityBase.

69 {
73  Coord direction(xState - 1, yState - 1);
74  double length = direction.length();
75  if (length)
76  lastSpeed = direction / length * speed;
77  else
80 }
Coord lastPosition
The last position that was reported.
Definition: MobilityBase.h:78
simtime_t nextChange
The next simulation time when the mobility module needs to update its internal state.
Definition: MovingMobilityBase.h:60
int yState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:38
Coord targetPosition
End position of current linear movement.
Definition: LineSegmentsMobilityBase.h:41
int xState
0 = negative direction, 1 = no move, 2 = positive direction
Definition: ChiangMobility.h:37
double speed
speed of the host
Definition: ChiangMobility.h:35
static const Coord ZERO
Definition: Coord.h:41
int getNextStateIndex(int currentState)
Gets the next state based on the current state.
Definition: ChiangMobility.cc:54
double stateTransitionUpdateInterval
how often to calculate the new state
Definition: ChiangMobility.h:36
Coord lastSpeed
The last speed that was reported at lastUpdate.
Definition: MovingMobilityBase.h:52

Member Data Documentation

double inet::ChiangMobility::speed
protected

speed of the host

Referenced by ChiangMobility(), initialize(), and setTargetPosition().

double inet::ChiangMobility::stateTransitionUpdateInterval
protected

how often to calculate the new state

Referenced by ChiangMobility(), initialize(), and setTargetPosition().

int inet::ChiangMobility::xState
protected

0 = negative direction, 1 = no move, 2 = positive direction

Referenced by ChiangMobility(), initialize(), and setTargetPosition().

int inet::ChiangMobility::yState
protected

0 = negative direction, 1 = no move, 2 = positive direction

Referenced by ChiangMobility(), initialize(), and setTargetPosition().


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