Allocate pairs of longitude and latitude (offset within orbit) for use in LeoCircularOrbitMobilityModel. More...

#include "leo-circular-orbit-position-allocator.h"

Inheritance diagram for ns3::LeoCircularOrbitAllocator:

Collaboration diagram for ns3::LeoCircularOrbitAllocator:

Classes
struct	Config
	Configuration parameters for the LEO circular orbit allocator. More...

Public Member Functions
	LeoCircularOrbitAllocator ()
	constructor
	~LeoCircularOrbitAllocator () override
	destructor
int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.
Vector	GetNext () const override
	Gets the next position on the longitude grid (base class compat).
LeoOrbitPosition	GetNextOrbitPosition () const
	Gets the next position on the longitude grid.
uint64_t	GetNumOrbits () const
	Get the number of orbits (planes) in the constellation.
uint64_t	GetNumSatellites () const
	Get the number of satellites per orbit.
uint16_t	GetPhasingFactor () const
	Get the phasing factor.
double	GetRaanSpanDeg () const
	Get the RAAN span in degrees.
void	SetNumOrbits (uint64_t num)
	Set the number of orbits (planes) in the constellation.
void	SetNumSatellites (uint64_t num)
	Set the number of satellites per orbit.
void	SetPhasingFactor (uint16_t factor)
	Set the phasing factor (angular spacing between adjacent orbits).
void	SetRaanSpanDeg (double deg)
	Set the RAAN (Right Ascension of the Ascending Node) span in degrees.
Public Member Functions inherited from ns3::PositionAllocator
	PositionAllocator ()
	~PositionAllocator () override
Public Member Functions inherited from ns3::Object
	Object ()
	Caller graph was not generated because of its size.
	~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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.
template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.
template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) 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.
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.
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 ()
	Get the type ID.
Static Public Member Functions inherited from ns3::PositionAllocator
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.

Private Attributes
struct ns3::LeoCircularOrbitAllocator::Config	m_config
	Configuration parameters.
uint64_t	m_lastOrbit {0}
	The last orbit that has been assigned.
uint64_t	m_lastSatellite {0}
	The last position inside the orbit that has been assigned.

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

Allocate pairs of longitude and latitude (offset within orbit) for use in LeoCircularOrbitMobilityModel.

Definition at line 43 of file leo-circular-orbit-position-allocator.h.

Constructor & Destructor Documentation

◆ LeoCircularOrbitAllocator()

ns3::LeoCircularOrbitAllocator::LeoCircularOrbitAllocator ( )

constructor

Definition at line 26 of file leo-circular-orbit-position-allocator.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~LeoCircularOrbitAllocator()

ns3::LeoCircularOrbitAllocator::~LeoCircularOrbitAllocator ( )

override

destructor

Definition at line 30 of file leo-circular-orbit-position-allocator.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::LeoCircularOrbitAllocator::AssignStreams ( int64_t stream )

overridevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

This method must be implement in subclasses.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 73 of file leo-circular-orbit-position-allocator.cc.

◆ GetNext()

Vector ns3::LeoCircularOrbitAllocator::GetNext ( ) const

overridevirtual

Gets the next position on the longitude grid (base class compat).

If all positions have been returned once, the first position is returned again and so on.

Returns: Vector where x is the longitude of the ascending node in degrees, y is the orbital offset in degrees, and z is the satellite index within the plane.

Implements ns3::PositionAllocator.

Definition at line 79 of file leo-circular-orbit-position-allocator.cc.

References GetNextOrbitPosition().

Here is the call graph for this function:

◆ GetNextOrbitPosition()

LeoOrbitPosition ns3::LeoCircularOrbitAllocator::GetNextOrbitPosition ( ) const

Gets the next position on the longitude grid.

If all positions have been returned once, the first position is returned again and so on.

Returns: LeoOrbitPosition with longitude of the ascending node in degrees (x), orbital offset / argument of latitude in degrees (y), and the satellite index within the plane (z).

Definition at line 86 of file leo-circular-orbit-position-allocator.cc.

References m_config, m_lastOrbit, and m_lastSatellite.

Referenced by GetNext().

Here is the caller graph for this function:

◆ GetNumOrbits()

uint64_t ns3::LeoCircularOrbitAllocator::GetNumOrbits ( ) const

inline

Get the number of orbits (planes) in the constellation.

Returns: Number of orbits.

Definition at line 99 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetNumSatellites()

uint64_t ns3::LeoCircularOrbitAllocator::GetNumSatellites ( ) const

inline

Get the number of satellites per orbit.

Returns: Number of satellites per orbit.

Definition at line 119 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetPhasingFactor()

uint16_t ns3::LeoCircularOrbitAllocator::GetPhasingFactor ( ) const

inline

Get the phasing factor.

Returns: Phasing factor.

Definition at line 139 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetRaanSpanDeg()

double ns3::LeoCircularOrbitAllocator::GetRaanSpanDeg ( ) const

inline

Get the RAAN span in degrees.

Returns: RAAN span in degrees.

Definition at line 159 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::LeoCircularOrbitAllocator::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file leo-circular-orbit-position-allocator.cc.

References LeoCircularOrbitAllocator(), ns3::PositionAllocator::PositionAllocator(), GetNumOrbits(), GetNumSatellites(), GetPhasingFactor(), GetRaanSpanDeg(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetNumOrbits(), SetNumSatellites(), ns3::TypeId::SetParent(), SetPhasingFactor(), and SetRaanSpanDeg().

Here is the call graph for this function:

◆ SetNumOrbits()

void ns3::LeoCircularOrbitAllocator::SetNumOrbits ( uint64_t num )

inline

Set the number of orbits (planes) in the constellation.

Parameters

num	Number of orbits.

Definition at line 89 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNumSatellites()

void ns3::LeoCircularOrbitAllocator::SetNumSatellites ( uint64_t num )

inline

Set the number of satellites per orbit.

Parameters

num	Number of satellites.

Definition at line 109 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPhasingFactor()

void ns3::LeoCircularOrbitAllocator::SetPhasingFactor ( uint16_t factor )

inline

Set the phasing factor (angular spacing between adjacent orbits).

Parameters

factor Phasing factor value.

Definition at line 129 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetRaanSpanDeg()

void ns3::LeoCircularOrbitAllocator::SetRaanSpanDeg ( double deg )

inline

Set the RAAN (Right Ascension of the Ascending Node) span in degrees.

Parameters

deg	RAAN span in degrees.

Definition at line 149 of file leo-circular-orbit-position-allocator.h.

References m_config.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_config

struct ns3::LeoCircularOrbitAllocator::Config ns3::LeoCircularOrbitAllocator::m_config

private

Configuration parameters.

Referenced by GetNextOrbitPosition(), GetNumOrbits(), GetNumSatellites(), GetPhasingFactor(), GetRaanSpanDeg(), SetNumOrbits(), SetNumSatellites(), SetPhasingFactor(), and SetRaanSpanDeg().

◆ m_lastOrbit

uint64_t ns3::LeoCircularOrbitAllocator::m_lastOrbit {0}

mutableprivate

The last orbit that has been assigned.

Definition at line 177 of file leo-circular-orbit-position-allocator.h.

Referenced by GetNextOrbitPosition().

◆ m_lastSatellite

uint64_t ns3::LeoCircularOrbitAllocator::m_lastSatellite {0}

mutableprivate

The last position inside the orbit that has been assigned.

Definition at line 179 of file leo-circular-orbit-position-allocator.h.

Referenced by GetNextOrbitPosition().

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

src/mobility/model/leo-circular-orbit-position-allocator.h
src/mobility/model/leo-circular-orbit-position-allocator.cc

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LeoCircularOrbitAllocator()

◆ ~LeoCircularOrbitAllocator()

Member Function Documentation

◆ AssignStreams()

◆ GetNext()

◆ GetNextOrbitPosition()

◆ GetNumOrbits()

◆ GetNumSatellites()

◆ GetPhasingFactor()

◆ GetRaanSpanDeg()

◆ GetTypeId()

◆ SetNumOrbits()

◆ SetNumSatellites()

◆ SetPhasingFactor()

◆ SetRaanSpanDeg()

Member Data Documentation

◆ m_config

◆ m_lastOrbit

◆ m_lastSatellite