Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Spectrum
Size of this type is 56 bytes (on a 64-bit architecture). More...

#include "wraparound-model.h"

Inheritance diagram for ns3::WraparoundModel:

Collaboration diagram for ns3::WraparoundModel:

Public Member Functions
	WraparoundModel ()=default
	Default constructor.

Ptr< MobilityModel >	GetVirtualMobilityModel (Ptr< const MobilityModel > tx, Ptr< const MobilityModel > rx) const
	Creates a disposable virtual mobility model for tx based on rx distance and a wraparound model.

virtual Vector3D	GetVirtualPosition (const Vector3D tx, const Vector3D rx) const
	Get virtual position of txPos with respect to rxPos.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T>
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type with the TypeId system.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Spectrum
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 16 of file wraparound-model.h.

Constructor & Destructor Documentation

◆ WraparoundModel()

ns3::WraparoundModel::WraparoundModel ( )

default

Default constructor.

Referenced by ns3::HexagonalWraparoundModel::GetTypeId(), and GetTypeId().

Here is the caller graph for this function:

Member Function Documentation

◆ GetTypeId()

TypeId WraparoundModel::GetTypeId ( )

static

Register this type with the TypeId system.

Returns: the object TypeId

Definition at line 21 of file wraparound-model.cc.

References ns3::Object::Object(), WraparoundModel(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetVirtualMobilityModel()

Ptr< MobilityModel > WraparoundModel::GetVirtualMobilityModel	(	Ptr< const MobilityModel >	tx,
		Ptr< const MobilityModel >	rx ) const

Creates a disposable virtual mobility model for tx based on rx distance and a wraparound model.

Parameters

tx	Transmitter mobility model
rx	Receiver Mobility model

Returns: virtual mobility model for transmitter

Definition at line 31 of file wraparound-model.cc.

References GetVirtualPosition(), and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ GetVirtualPosition()

Vector3D WraparoundModel::GetVirtualPosition	(	const Vector3D	tx,
		const Vector3D	rx ) const

virtual

Get virtual position of txPos with respect to rxPos.

Each wraparound model should override this function with their own implementation

Parameters

tx	Transmitter position
rx	Receiver position

Returns: virtual position of transmitter in respect to receiver position

Reimplemented in ns3::HexagonalWraparoundModel.

Definition at line 60 of file wraparound-model.cc.

Referenced by GetVirtualMobilityModel().

Here is the caller graph for this function:

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

src/spectrum/model/wraparound-model.h
src/spectrum/model/wraparound-model.cc

Public Member Functions

Static Public Member Functions