Uses the <position_change> elements of the ANSim tool's trace file. More...

#include <AnsimMobility.h>

Inheritance diagram for inet::AnsimMobility:

Public Member Functions
virtual double	getMaxSpeed () const override
	Returns the maximum possible speed at any future time. More...

	AnsimMobility ()

Public Member Functions inherited from inet::LineSegmentsMobilityBase
	LineSegmentsMobilityBase ()

Public Member Functions inherited from inet::MovingMobilityBase
virtual const Coord &	getCurrentPosition () override
	Returns the position at the current simulation time. More...

virtual const Coord &	getCurrentVelocity () override
	Returns the velocity at the current simulation time. More...

virtual const Coord &	getCurrentAcceleration () override
	Returns the acceleration at the current simulation time. More...

virtual const Quaternion &	getCurrentAngularPosition () override
	Returns the angular position at the current simulation time. More...

virtual const Quaternion &	getCurrentAngularVelocity () override
	Returns the angular velocity at the current simulation time. More...

virtual const Quaternion &	getCurrentAngularAcceleration () override
	Returns the angular acceleration at the current simulation time. More...

Public Member Functions inherited from inet::MobilityBase
virtual const Coord &	getConstraintAreaMax () const override
	Returns the maximum position along each axes for. More...

virtual const Coord &	getConstraintAreaMin () const override
	Returns the minimum position along each axes for. More...

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	setTargetPosition () override
	Overridden from LineSegmentsMobilityBase. More...

virtual void	move () override
	Overridden from LineSegmentsMobilityBase. More...

virtual cXMLElement *	findNextPositionChange (cXMLElement *positionChange)
	Finds the next <position_change> element. More...

virtual void	extractDataFrom (cXMLElement *node)
	Utility: extract data from given <position_update> element. More...

virtual void	computeMaxSpeed ()

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...

virtual void	orient ()

Protected Member Functions inherited from inet::MobilityBase
	MobilityBase ()

virtual int	getId () const override

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)

Protected Attributes
int	nodeId
	we'll have to compare this to the <node_id> elements More...

cXMLElement *	nextPositionChange
	points to the next <position_change> element More...

double	maxSpeed

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	lastVelocity
	The last velocity that was reported at lastUpdate. More...

Quaternion	lastAngularVelocity
	The last angular velocity 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...

bool	faceForward

Protected Attributes inherited from inet::MobilityBase
cModule *	subjectModule
	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...

Quaternion	lastOrientation
	The last orientation that was reported. More...

StringFormat	format

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

Uses the <position_change> elements of the ANSim tool's trace file.

See NED file for more info.

Constructor & Destructor Documentation

◆ AnsimMobility()

inet::AnsimMobility::AnsimMobility ( )

 {
     maxSpeed = 0;
     nodeId = -1;
     nextPositionChange = nullptr;
 }

Member Function Documentation

◆ computeMaxSpeed()

void inet::AnsimMobility::computeMaxSpeed ( )

protectedvirtual

 {
     cXMLElement *rootElem = par("ansimTrace");
     cXMLElement *curElem = rootElem->getElementByPath("mobility/position_change");
     if (!curElem)
         throw cRuntimeError("Element doesn't have <mobility> child or <position_change> grandchild at %s",
                 rootElem->getSourceLocation());
     cXMLElement *nextElem = findNextPositionChange(curElem);
     if (!nextElem)
         throw cRuntimeError("Element doesn't have second <position_change> grandchild at %s",
                 curElem->getSourceLocation());
     curElem = nextElem;
     cXMLElement *destElem = firstChildWithTag(curElem, "destination");
     const char *xStr = firstChildWithTag(destElem, "xpos")->getNodeValue();
     const char *yStr = firstChildWithTag(destElem, "ypos")->getNodeValue();
     Coord lastPos(atof(xStr), atof(yStr), 0);
     // first position is the initial position so we don't take it into account to compute maxSpeed
     if (curElem)
         curElem = curElem->getNextSibling();
     while (curElem) {
         cXMLElement *destElem = firstChildWithTag(curElem, "destination");
         const char *xStr = firstChildWithTag(destElem, "xpos")->getNodeValue();
         const char *yStr = firstChildWithTag(destElem, "ypos")->getNodeValue();
         const char *startTimeStr = firstChildWithTag(curElem, "start_time")->getNodeValue();
         const char *endTimeStr = firstChildWithTag(curElem, "end_time")->getNodeValue();
         double elapsedTime = atof(endTimeStr) - atof(startTimeStr);
         if (elapsedTime == 0)
             throw cRuntimeError("Elapsed time is zero: infinite speed");
         Coord currentPos(atof(xStr), atof(yStr), 0);
         double distance = currentPos.distance(lastPos);
         double currentSpeed = distance / elapsedTime;
         if (currentSpeed > maxSpeed)
             maxSpeed = currentSpeed;
         lastPos = currentPos;
         curElem = findNextPositionChange(curElem->getNextSibling());
     }
 }

Referenced by initialize().

◆ extractDataFrom()

void inet::AnsimMobility::extractDataFrom ( cXMLElement * node )

protectedvirtual

Utility: extract data from given <position_update> element.

 {
     // extract data from <position_change> element
     // FIXME start_time has to be taken into account too! as pause from prev element's end_time
     const char *startTimeStr = firstChildWithTag(node, "start_time")->getNodeValue();
     if (!startTimeStr)
         throw cRuntimeError("No content in <start_time> element at %s", node->getSourceLocation());
     const char *endTimeStr = firstChildWithTag(node, "end_time")->getNodeValue();
     if (!endTimeStr)
         throw cRuntimeError("No content in <end_time> element at %s", node->getSourceLocation());
     cXMLElement *destElem = firstChildWithTag(node, "destination");
     const char *xStr = firstChildWithTag(destElem, "xpos")->getNodeValue();
     const char *yStr = firstChildWithTag(destElem, "ypos")->getNodeValue();
     if (!xStr || !yStr)
         throw cRuntimeError("No content in <destination>/<xpos> or <ypos> element at %s", node->getSourceLocation());
  
     nextChange = atof(endTimeStr);
     targetPosition.x = atof(xStr);
     targetPosition.y = atof(yStr);
 }

Referenced by setInitialPosition(), and setTargetPosition().

◆ findNextPositionChange()

cXMLElement * inet::AnsimMobility::findNextPositionChange ( cXMLElement * positionChange )

protectedvirtual

Finds the next <position_change> element.

 {
     // find next <position_change> element with matching <node_id> tag (current one also OK)
     while (positionChange) {
         const char *nodeIdStr = firstChildWithTag(positionChange, "node_id")->getNodeValue();
         if (nodeIdStr && atoi(nodeIdStr) == nodeId)
             break;
  
         positionChange = positionChange->getNextSibling();
     }
     return positionChange;
 }

Referenced by computeMaxSpeed(), setInitialPosition(), and setTargetPosition().

◆ getMaxSpeed()

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

inlineoverridevirtual

Returns the maximum possible speed at any future time.

Reimplemented from inet::MobilityBase.

53 { return maxSpeed; }

◆ initialize()

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

overrideprotectedvirtual

Initializes mobility model parameters.

Reimplemented from inet::MovingMobilityBase.

 {
     LineSegmentsMobilityBase::initialize(stage);
  
     EV_TRACE << "initializing AnsimMobility stage " << stage << endl;
     if (stage == INITSTAGE_LOCAL) {
         nodeId = par("nodeId");
         if (nodeId == -1)
             nodeId = getContainingNode(this)->getIndex();
  
         // get script: param should point to <simulation> element
         cXMLElement *rootElem = par("ansimTrace");
         if (strcmp(rootElem->getTagName(), "simulation") != 0)
             throw cRuntimeError("<simulation> is expected as root element not <%s> at %s",
                     rootElem->getTagName(), rootElem->getSourceLocation());
         nextPositionChange = rootElem->getElementByPath("mobility/position_change");
         if (!nextPositionChange)
             throw cRuntimeError("Element doesn't have <mobility> child or <position_change> grandchild at %s",
                     rootElem->getSourceLocation());
         computeMaxSpeed();
     }
 }

◆ move()

void inet::AnsimMobility::move ( )

overrideprotectedvirtual

Overridden from LineSegmentsMobilityBase.

Reimplemented from inet::LineSegmentsMobilityBase.

 {
     LineSegmentsMobilityBase::move();
     raiseErrorIfOutside();
 }

◆ numInitStages()

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

inlineoverrideprotectedvirtual

Returns the required number of initialize stages.

Reimplemented from inet::MobilityBase.

31 { return NUM_INIT_STAGES; }

◆ setInitialPosition()

void inet::AnsimMobility::setInitialPosition ( )

overrideprotectedvirtual

Initializes the position according to the mobility model.

Reimplemented from inet::MobilityBase.

 {
     cXMLElement *firstPositionChange = findNextPositionChange(nextPositionChange);
     if (firstPositionChange)
         extractDataFrom(firstPositionChange);
     lastPosition = targetPosition;
 }

◆ setTargetPosition()

void inet::AnsimMobility::setTargetPosition ( )

overrideprotectedvirtual

Overridden from LineSegmentsMobilityBase.

Implements inet::LineSegmentsMobilityBase.

 {
     nextPositionChange = findNextPositionChange(nextPositionChange);
     if (!nextPositionChange) {
         nextChange = -1;
         stationary = true;
         targetPosition = lastPosition;
         return;
     }
  
     // extract data from it
     extractDataFrom(nextPositionChange);
  
     // skip this one
     nextPositionChange = nextPositionChange->getNextSibling();
 }

Member Data Documentation

◆ maxSpeed

double inet::AnsimMobility::maxSpeed

protected

Referenced by AnsimMobility(), and computeMaxSpeed().

◆ nextPositionChange

cXMLElement* inet::AnsimMobility::nextPositionChange

protected

points to the next <position_change> element

Referenced by AnsimMobility(), initialize(), setInitialPosition(), and setTargetPosition().

◆ nodeId

int inet::AnsimMobility::nodeId

protected

we'll have to compare this to the <node_id> elements

Referenced by AnsimMobility(), findNextPositionChange(), and initialize().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AnsimMobility()

Member Function Documentation

◆ computeMaxSpeed()

◆ extractDataFrom()

◆ findNextPositionChange()

◆ getMaxSpeed()

◆ initialize()

◆ move()

◆ numInitStages()

◆ setInitialPosition()

◆ setTargetPosition()

Member Data Documentation

◆ maxSpeed

◆ nextPositionChange

◆ nodeId