Keep track of the current position and velocity of an object in satellite network. More...

#include "satellite-mobility-model.h"

Inheritance diagram for ns3::SatMobilityModel:

Collaboration diagram for ns3::SatMobilityModel:

Public Types
typedef void(*	CourseChangeCallback) (const Ptr< const SatMobilityModel > model)
	Callback signature for SatCourseChange trace source.

Public Member Functions
	SatMobilityModel ()
	Default constructor.
virtual	~SatMobilityModel ()=0
	Destructor for SatMobilityModel.
virtual Ptr< MobilityModel >	Copy () const =0
	Copy function allows one to copy the underlying MobilityModel from a MobilityModel pointer, by calling each children Copy implementation.
double	GetDistanceFrom (Ptr< const SatMobilityModel > position) const
GeoCoordinate	GetGeoPosition (void) const
void	NotifyGeoCourseChange (void) const
void	SetGeoPosition (const GeoCoordinate &position)

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID.

Private Member Functions
virtual GeoCoordinate	DoGetGeoPosition (void) const =0
virtual Vector	DoGetPosition (void) const
void	DoSetCartesianPosition (const Vector &position) const
	This method is used to force update of cartesian position.
virtual void	DoSetGeoPosition (const GeoCoordinate &position)=0
virtual void	DoSetPosition (const Vector &position)

Private Attributes
Vector	m_cartesianPosition
bool	m_cartesianPositionOutdated
bool	m_GetAsGeoCoordinates
ns3::TracedCallback< Ptr< const SatMobilityModel > >	m_satCourseChangeTrace
	Used to alert subscribers that a change in direction, velocity, or position has occurred.

Detailed Description

Keep track of the current position and velocity of an object in satellite network.

All space coordinates in this class and its subclasses are treated as geodetic coordinates. Support for setting and getting information in Cartesian coordinates also provided.

This is a base class for all satellite mobility models.

Definition at line 41 of file satellite-mobility-model.h.

Member Typedef Documentation

◆ CourseChangeCallback

typedef void(* ns3::SatMobilityModel::CourseChangeCallback) (const Ptr< const SatMobilityModel > model)

Callback signature for SatCourseChange trace source.

Parameters

model the SatMobilityModel which is changing course

Definition at line 91 of file satellite-mobility-model.h.

Constructor & Destructor Documentation

◆ SatMobilityModel()

ns3::SatMobilityModel::SatMobilityModel ( )

Default constructor.

Definition at line 61 of file satellite-mobility-model.cc.

References m_cartesianPositionOutdated, and m_GetAsGeoCoordinates.

Referenced by ns3::SatConstantPositionMobilityModel::GetTypeId(), ns3::SatSGP4MobilityModel::GetTypeId(), and ns3::SatTracedMobilityModel::GetTypeId().

Here is the caller graph for this function:

◆ ~SatMobilityModel()

ns3::SatMobilityModel::~SatMobilityModel ( )

pure virtual

Destructor for SatMobilityModel.

Definition at line 67 of file satellite-mobility-model.cc.

Member Function Documentation

◆ Copy()

virtual Ptr< MobilityModel > ns3::SatMobilityModel::Copy ( ) const

pure virtual

Copy function allows one to copy the underlying MobilityModel from a MobilityModel pointer, by calling each children Copy implementation.

This is primarily used by wraparound models for the spectrum channel.

Returns: a copy of the current mobility model

Implemented in ns3::SatConstantPositionMobilityModel, ns3::SatSGP4MobilityModel, and ns3::SatTracedMobilityModel.

◆ DoGetGeoPosition()

virtual GeoCoordinate ns3::SatMobilityModel::DoGetGeoPosition ( void ) const

privatepure virtual

Returns: the current position.

Concrete subclasses of this base class must implement this method.

Implemented in ns3::SatConstantPositionMobilityModel, ns3::SatSGP4MobilityModel, and ns3::SatTracedMobilityModel.

Referenced by DoGetPosition(), GetDistanceFrom(), and GetGeoPosition().

Here is the caller graph for this function:

◆ DoGetPosition()

Vector ns3::SatMobilityModel::DoGetPosition ( void ) const

privatevirtual

Returns: cartesian format position as vector

Implementation for method defined by MobilityModel

Reimplemented in ns3::SatSGP4MobilityModel, and ns3::SatTracedMobilityModel.

Definition at line 100 of file satellite-mobility-model.cc.

References DoGetGeoPosition(), DoSetCartesianPosition(), m_cartesianPosition, m_cartesianPositionOutdated, and ns3::GeoCoordinate::ToVector().

Here is the call graph for this function:

◆ DoSetCartesianPosition()

void ns3::SatMobilityModel::DoSetCartesianPosition ( const Vector & position ) const

private

This method is used to force update of cartesian position.

Cartesian position is updated when position is set by method DoSetPosition. In case that position is updated by method DoSetGeoPosition cartesian position is updated only if it is requested by method DoGetPosition.

Parameters

position position in cartesian format to set

Definition at line 128 of file satellite-mobility-model.cc.

References m_cartesianPosition, and m_cartesianPositionOutdated.

Referenced by DoGetPosition().

Here is the caller graph for this function: