inet::Ns2MotionMobility Class Reference

#include <Ns2MotionMobility.h>

Inheritance diagram for inet::Ns2MotionMobility:

Public Member Functions
	Ns2MotionMobility ()
virtual	~Ns2MotionMobility ()
virtual double	getMaxSpeed () const override
	Returns the maximum possible speed at any future time. More...
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
void	parseFile (const char *filename)
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 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...
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
unsigned int	vecpos
Ns2MotionFile *	ns2File
int	nodeId
double	scrollX
double	scrollY
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	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...

Constructor & Destructor Documentation

inet::Ns2MotionMobility::Ns2MotionMobility

(

)

{
    vecpos = 0;
    ns2File = nullptr;
    nodeId = 0;
    scrollX = 0;
    scrollY = 0;
    maxSpeed = 0;
}

inet::Ns2MotionMobility::~Ns2MotionMobility ( )

virtual

{
    if (ns2File)
        delete ns2File;
}

Member Function Documentation

void inet::Ns2MotionMobility::computeMaxSpeed ( )

protectedvirtual

{
    unsigned int fileSize = ns2File->lines.size();
    for (unsigned int i = 0; i < fileSize; i++)
    {
        const Ns2MotionFile::Line& vec = ns2File->lines[i];
        if (vec[3] > maxSpeed)
            maxSpeed = vec[3];
    }
}

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

inlineoverridevirtual

Returns the maximum possible speed at any future time.

Reimplemented from inet::MobilityBase.

{ return maxSpeed; }

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

overrideprotectedvirtual

Initializes mobility model parameters.

Reimplemented from inet::MovingMobilityBase.

{
    LineSegmentsMobilityBase::initialize(stage);

    EV_TRACE << "initializing Ns2MotionMobility stage " << stage << endl;
    if (stage == INITSTAGE_LOCAL) {
        scrollX = par("scrollX");
        scrollY = par("scrollY");
        nodeId = par("nodeId");
        if (nodeId == -1)
            nodeId = getContainingNode(this)->getIndex();
        const char *fname = par("traceFile");
        ns2File = new Ns2MotionFile;
        parseFile(fname);
        vecpos = 0;
        WATCH(nodeId);
    }
}

void inet::Ns2MotionMobility::move ( )

overrideprotectedvirtual

Overridden from LineSegmentsMobilityBase.

Reimplemented from inet::LineSegmentsMobilityBase.

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

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

inlineoverrideprotectedvirtual

Returns the required number of initialize stages.

Reimplemented from inet::MobilityBase.

{ return NUM_INIT_STAGES; }

void inet::Ns2MotionMobility::parseFile ( const char *  filename )

protected

Referenced by initialize().

{
    std::ifstream in(filename, std::ios::in);

    if (in.fail())
        throw cRuntimeError("Cannot open file '%s'", filename);
    ns2File->initial[0] = ns2File->initial[1] = ns2File->initial[2] = -1;
    std::string line;
    std::string subline;

    while (std::getline(in, line)) {
        // '#' line
        int num_node = -1;
        std::string::size_type found = line.find('#');
        if (found == 0)
            continue;
        if (found != std::string::npos)
            subline = line;
        else
            subline = line.substr(0, found);
        found = subline.find("$node_");
        if (found == std::string::npos)
            continue;
        // Node Id
        std::string::size_type pos1 = subline.find('(');
        std::string::size_type pos2 = subline.find(')');
        if (pos2 - pos1 > 1)
            num_node = std::atoi(subline.substr(pos1 + 1, pos2 - 1).c_str());
        if (num_node != nodeId)
            continue;
        // Initial position
        found = subline.find("set ");
        if (found != std::string::npos) {
            // Initial position
            found = subline.find("X_");
            if (found != std::string::npos) {
                ns2File->initial[0] = std::atof(subline.substr(found + 3, std::string::npos).c_str());
            }
            found = subline.find("Y_");
            if (found != std::string::npos) {
                ns2File->initial[1] = std::atof(subline.substr(found + 3, std::string::npos).c_str());
            }

            found = subline.find("Z_");
            if (found != std::string::npos) {
                ns2File->initial[2] = std::atof(subline.substr(found + 3, std::string::npos).c_str());
            }
        }
        found = subline.find("setdest");
        if (found != std::string::npos) {
            ns2File->lines.push_back(Ns2MotionFile::Line());
            Ns2MotionFile::Line& vec = ns2File->lines.back();
            // initial time
            found = subline.find("at");
            vec.push_back(std::atof(subline.substr(found + 3).c_str()));

            std::string parameters = subline.substr(subline.find("setdest ") + 8, std::string::npos);

            std::stringstream linestream(parameters);
            double d;
            while (linestream >> d)
                vec.push_back(d);
        }
    }
    in.close();
    // exist data?
    if (ns2File->initial[0] == -1 || ns2File->initial[1] == -1 || ns2File->initial[2] == -1)
        throw cRuntimeError("node '%d' Error ns2 motion file '%s'", nodeId, filename);
}

void inet::Ns2MotionMobility::setInitialPosition ( )

overrideprotectedvirtual

Initializes the position according to the mobility model.

Reimplemented from inet::MobilityBase.

{
    lastPosition.x = ns2File->initial[0] + scrollX;
    lastPosition.y = ns2File->initial[1] + scrollY;
}

void inet::Ns2MotionMobility::setTargetPosition ( )

overrideprotectedvirtual

Overridden from LineSegmentsMobilityBase.

Implements inet::LineSegmentsMobilityBase.

{
    if (ns2File->lines.size() == 0) {
        stationary = true;
        return;
    }

    if (vecpos >= ns2File->lines.size()) {
        stationary = true;
        return;
    }

    if (ns2File->lines.begin() + vecpos == ns2File->lines.end()) {
        stationary = true;
        return;
    }

    const Ns2MotionFile::Line& vec = ns2File->lines[vecpos];
    double time = vec[0];
    simtime_t now = simTime();
    // TODO: this code is dubious at best
    if (now < time) {
        nextChange = time;
        targetPosition = lastPosition;
    }
    else if (vec[3] == 0) {    // the node is stopped
        const Ns2MotionFile::Line& vec = ns2File->lines[vecpos + 1];
        double time = vec[0];
        nextChange = time;
        targetPosition = lastPosition;
        vecpos++;
    }
    else {
        targetPosition.x = vec[1] + scrollX;
        targetPosition.y = vec[2] + scrollY;
        double speed = vec[3];
        double distance = lastPosition.distance(targetPosition);
        double travelTime = distance / speed;
        nextChange = now + travelTime;
        vecpos++;
    }
}

Member Data Documentation

double inet::Ns2MotionMobility::maxSpeed

protected

Referenced by computeMaxSpeed(), and Ns2MotionMobility().

int inet::Ns2MotionMobility::nodeId

protected

Referenced by initialize(), Ns2MotionMobility(), and parseFile().

Ns2MotionFile* inet::Ns2MotionMobility::ns2File

protected

Referenced by computeMaxSpeed(), initialize(), Ns2MotionMobility(), parseFile(), setInitialPosition(), setTargetPosition(), and ~Ns2MotionMobility().

double inet::Ns2MotionMobility::scrollX

protected

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

double inet::Ns2MotionMobility::scrollY

protected

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

unsigned int inet::Ns2MotionMobility::vecpos

protected

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

---

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

• Ns2MotionMobility.h
• Ns2MotionMobility.cc