wsf::comm::medium::Mode Class Reference

#include <WsfCommMedium.hpp>

Inheritance diagram for wsf::comm::medium::Mode:

Public Member Functions
	Mode ()=default
	Mode (const std::string &aName)
virtual	~Mode ()=default
	Mode (const Mode &aSrc)=default
virtual Mode *	Clone () const =0
const char *	GetScriptClassName () const override
virtual bool	ProcessInput (UtInput &aInput)
virtual double	GetTransmissionTime (double aSimTime, Comm &aXmtr, Layer *aLayerPtr, Message &aMessage)=0
virtual double	GetPropagationTime (double aSimTime, Comm &aXmtr, Comm &aRcvr, Message &aMessage)=0
virtual double	GetPacketLossTime (double aSimTime, Message &aMessage)=0
const std::string &	GetName () const
void	SetName (const std::string &aName)

Detailed Description

The Mode class represents a functional state of a medium. Each medium can be made up of one or more Mode objects that allow the medium to change its behavior depending on the mode selected. This allows for unique handling of each message dependent on user defined criteria (e.g. the recipient, distance, channel utilization, etc.)

Constructor & Destructor Documentation

Mode() [1/3]

wsf::comm::medium::Mode::Mode ( )

default

Referenced by Clone(), Mode(), and wsf::comm::medium::ModeGuided::ModeGuided().

Mode() [2/3]

wsf::comm::medium::Mode::Mode ( const std::string & aName )

inline

~Mode()

virtual wsf::comm::medium::Mode::~Mode ( )

virtualdefault

Mode() [3/3]

wsf::comm::medium::Mode::Mode ( const Mode & aSrc )

default

References Mode().

Member Function Documentation

Clone()

virtual Mode * wsf::comm::medium::Mode::Clone ( ) const

pure virtual

Implemented in wsf::comm::medium::ModeGuided, and wsf::comm::medium::ModeUnguided.

References Mode().

GetName()

const std::string & wsf::comm::medium::Mode::GetName ( ) const

inline

GetPacketLossTime()

virtual double wsf::comm::medium::Mode::GetPacketLossTime ( double aSimTime, Message & aMessage )

pure virtual

Implemented in wsf::comm::medium::ModeGuided.

GetPropagationTime()

virtual double wsf::comm::medium::Mode::GetPropagationTime ( double aSimTime, Comm & aXmtr, Comm & aRcvr, Message & aMessage )

pure virtual

Implemented in wsf::comm::medium::ModeGuided.

GetScriptClassName()

const char * wsf::comm::medium::Mode::GetScriptClassName ( ) const

inlineoverride

GetTransmissionTime()

virtual double wsf::comm::medium::Mode::GetTransmissionTime ( double aSimTime, Comm & aXmtr, Layer * aLayerPtr, Message & aMessage )

pure virtual

Implemented in wsf::comm::medium::ModeGuided, and wsf::comm::medium::ModeUnguided.

ProcessInput()

virtual bool wsf::comm::medium::Mode::ProcessInput ( UtInput & aInput )

inlinevirtual

Reimplemented in wsf::comm::medium::ModeGuided, and wsf::comm::medium::ModeUnguided.

SetName()

void wsf::comm::medium::Mode::SetName ( const std::string & aName )

inline

---

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

• WsfCommMedium.hpp