Loading...
Searching...
No Matches
ns3::SatConstantPositionMobilityModel Class Reference

Satellite mobility model for which the current position does not change once it has been set and until it is set again explicitly to a new value. More...

#include "satellite-constant-position-mobility-model.h"

Inheritance diagram for ns3::SatConstantPositionMobilityModel:
Collaboration diagram for ns3::SatConstantPositionMobilityModel:

Public Member Functions

 SatConstantPositionMobilityModel ()
 Create a position located at coordinates (0, 0, 0).
virtual ~SatConstantPositionMobilityModel ()
 Destructor for SatConstantPositionMobilityModel.
Ptr< MobilityModel > Copy () const override
 Copy function allows one to copy the underlying MobilityModel from a MobilityModel pointer, by calling each children Copy implementation.
Public Member Functions inherited from ns3::SatMobilityModel
 SatMobilityModel ()
 Default constructor.
virtual ~SatMobilityModel ()=0
 Destructor for SatMobilityModel.
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.
Static Public Member Functions inherited from ns3::SatMobilityModel
static TypeId GetTypeId (void)
 Get the type ID.

Private Member Functions

virtual GeoCoordinate DoGetGeoPosition (void) const
Vector DoGetVelocity (void) const
virtual void DoSetGeoPosition (const GeoCoordinate &position)

Private Attributes

GeoCoordinate m_geoPosition

Additional Inherited Members

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

Detailed Description

Satellite mobility model for which the current position does not change once it has been set and until it is set again explicitly to a new value.

Definition at line 35 of file satellite-constant-position-mobility-model.h.

Constructor & Destructor Documentation

◆ SatConstantPositionMobilityModel()

ns3::SatConstantPositionMobilityModel::SatConstantPositionMobilityModel ( )

Create a position located at coordinates (0, 0, 0).

Definition at line 43 of file satellite-constant-position-mobility-model.cc.

◆ ~SatConstantPositionMobilityModel()

ns3::SatConstantPositionMobilityModel::~SatConstantPositionMobilityModel ( )
virtual

Destructor for SatConstantPositionMobilityModel.

Definition at line 48 of file satellite-constant-position-mobility-model.cc.

Member Function Documentation

◆ Copy()

Ptr< MobilityModel > ns3::SatConstantPositionMobilityModel::Copy ( ) const
inlineoverridevirtual

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

Implements ns3::SatMobilityModel.

Definition at line 54 of file satellite-constant-position-mobility-model.h.

◆ DoGetGeoPosition()

GeoCoordinate ns3::SatConstantPositionMobilityModel::DoGetGeoPosition ( void ) const
privatevirtual
Returns
the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::SatMobilityModel.

Definition at line 54 of file satellite-constant-position-mobility-model.cc.

References m_geoPosition.

◆ DoGetVelocity()

Vector ns3::SatConstantPositionMobilityModel::DoGetVelocity ( void ) const
private

Definition at line 71 of file satellite-constant-position-mobility-model.cc.

◆ DoSetGeoPosition()

void ns3::SatConstantPositionMobilityModel::DoSetGeoPosition ( const GeoCoordinate & position)
privatevirtual
Parameters
positionthe position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::SatMobilityModel.

Definition at line 62 of file satellite-constant-position-mobility-model.cc.

References m_geoPosition, and ns3::SatMobilityModel::NotifyGeoCourseChange().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatConstantPositionMobilityModel::GetTypeId ( void )
static

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file satellite-constant-position-mobility-model.cc.

References ns3::SatMobilityModel::SatMobilityModel().

Here is the call graph for this function:

Member Data Documentation

◆ m_geoPosition

GeoCoordinate ns3::SatConstantPositionMobilityModel::m_geoPosition
mutableprivate

Definition at line 65 of file satellite-constant-position-mobility-model.h.

Referenced by DoGetGeoPosition(), and DoSetGeoPosition().

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