Keep track of the current location of an object. More...

#include <canvas-location.h>

Inheritance diagram for ns3::CanvasLocation:

Collaboration diagram for ns3::CanvasLocation:

Public Member Functions
Vector	GetLocation (void) const
void	SetLocation (const Vector &location)
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::CanvasLocation.

Detailed Description

Keep track of the current location of an object.

This can be used anytime a logical node location is needed (as opposed to a physical location used by the wireless PHY layer to calculate path loss). One potential use of this is by the animator to determine where to position the node icon on the animation display. Location units are arbitrary and dimensionless. In the case of use by the animator they dimensions are in pixels.

Member Function Documentation

Vector ns3::CanvasLocation::GetLocation ( void ) const

Returns:: the current location

static TypeId ns3::CanvasLocation::GetTypeId ( void ) [static]

This method returns the TypeId associated to ns3::CanvasLocation.

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::CanvasLocation
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::CanvasLocation

Attributes defined for this type:

Location: The current location on the canvas.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: write read

No TraceSources defined for this type.

Reimplemented from ns3::Object.

void ns3::CanvasLocation::SetLocation ( const Vector & location )

Parameters:

location

the location to set.

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

src/helper/canvas-location.h
doc/introspected-doxygen.h

ns3::CanvasLocation Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation