wsf::comm::router::RouterComponent Class Reference

#include <WsfCommRouterComponent.hpp>

Inheritance diagram for wsf::comm::router::RouterComponent:

Collaboration diagram for wsf::comm::router::RouterComponent:

Public Member Functions
	RouterComponent ()=default
	~RouterComponent () override=default
Router *	GetRouter () const
WsfSimulation *	GetSimulation () const
NetworkManager *	GetNetworkManager () const
virtual void	Setup ()
virtual void	PendingStart ()
virtual bool	Initialize (double aSimTime)
virtual bool	Initialize2 (double aSimTime)
virtual bool	PreInitialize (double aSimTime)
virtual bool	ProcessInput (UtInput &aInput)
Public Member Functions inherited from WsfComponentT< Router >
	WsfComponentT ()
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
virtual void	ComponentParentChanged (ParentType *aParentPtr)
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual WsfComponent *	CloneComponent () const =0
virtual WsfStringId	GetComponentName () const =0
virtual const int *	GetComponentRoles () const =0
virtual void *	QueryInterface (int aRole)=0
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual void	PreInput ()

Additional Inherited Members
Public Types inherited from WsfComponentT< Router >
typedef Router	ParentType
	This is needed to support the WsfComponentList template.

Detailed Description

This is an abstract base class for router components. Users wishing to add components to enhance or extend routing capabilities by adding components can use this interface.

Constructor & Destructor Documentation

RouterComponent()

wsf::comm::router::RouterComponent::RouterComponent ( )

default

~RouterComponent()

wsf::comm::router::RouterComponent::~RouterComponent ( )

overridedefault

Member Function Documentation

GetNetworkManager()

NetworkManager * wsf::comm::router::RouterComponent::GetNetworkManager

(

)

const

References GetRouter().

GetRouter()

Router * wsf::comm::router::RouterComponent::GetRouter ( ) const

inline

References WsfComponentT< Router >::GetComponentParent().

Referenced by wsf::comm::router::ProtocolAdHoc::ExecuteOnCommAdded(), wsf::comm::router::ProtocolAdHoc::ExecuteOnCommRemoved(), wsf::comm::router::ProtocolAdHoc::ExecuteOnConnectionAdded(), wsf::comm::router::ProtocolAdHoc::ExecuteOnConnectionRemoved(), wsf::comm::router::ProtocolAdHoc::ExecuteOnMessageRouting(), wsf::comm::router::ProtocolOSPF::GetAllOSPF(), GetNetworkManager(), wsf::comm::router::ProtocolOSPF::GetPriorityInterface(), wsf::comm::router::ProtocolAdHoc::Initialize(), wsf::comm::router::ProtocolOSPF::Initialize(), wsf::comm::router::ProtocolAdHoc::InitializeState(), wsf::comm::router::ProtocolMulticast::Receive(), wsf::comm::router::ProtocolAdHoc::Routing(), wsf::comm::router::ProtocolLegacy::Routing(), wsf::comm::router::ProtocolMulticast::Routing(), wsf::comm::router::ProtocolOSPF::Routing(), wsf::comm::router::rip::RIPv2::Routing(), wsf::comm::router::ProtocolMulticast::Send(), wsf::comm::router::ProtocolOSPF::SendHello(), wsf::comm::router::ProtocolOSPF::SetRouterRoleType(), wsf::comm::router::rip::RIPv2::TurnOn(), and wsf::comm::router::ProtocolAdHoc::ValidNetwork().

GetSimulation()

WsfSimulation * wsf::comm::router::RouterComponent::GetSimulation

(

)

const

References WsfComponentT< Router >::GetComponentParent(), and WsfPlatformPart::GetSimulation().

Referenced by wsf::comm::router::ProtocolOSPF::DR_GraphDrop(), wsf::comm::router::OSPF_Area::ElectionDR(), wsf::comm::router::ProtocolOSPF::GetGraph(), wsf::comm::router::ProtocolAdHoc::Initialize(), wsf::comm::router::ProtocolLegacy::Initialize(), wsf::comm::router::ProtocolMulticast::Initialize(), wsf::comm::router::ProtocolOSPF::Initialize(), wsf::comm::router::rip::RIPv2::Initialize(), wsf::comm::router::ProtocolAdHoc::InitializeState(), wsf::comm::router::ProtocolAdHoc::PerfectCommAdded(), wsf::comm::router::ProtocolAdHoc::PerfectCommRemoved(), wsf::comm::router::ProtocolAdHoc::PerfectConnectionAdded(), wsf::comm::router::ProtocolAdHoc::PerfectConnectionRemoved(), wsf::comm::router::ProtocolOSPF::PlatformInitialized(), wsf::comm::router::ProtocolOSPF::ReceiveDR_GraphAdd(), wsf::comm::router::ProtocolOSPF::ReceiveDR_GraphDrop(), wsf::comm::router::ProtocolOSPF::ReceiveHello(), wsf::comm::router::ProtocolOSPF::RouteExternallyASBR(), wsf::comm::router::ProtocolOSPF::RouteFromBackbone(), wsf::comm::router::ProtocolOSPF::RouteToBackbone(), wsf::comm::router::ProtocolOSPF::Routing(), wsf::comm::router::ProtocolOSPF::ScheduleEvent(), wsf::comm::router::ProtocolOSPF::SendDR_GraphAdd(), wsf::comm::router::ProtocolOSPF::SendDR_GraphDrop(), wsf::comm::router::ProtocolOSPF::SendHello(), wsf::comm::router::ProtocolLegacy::Setup(), wsf::comm::router::ProtocolMulticast::Setup(), wsf::comm::router::ProtocolOSPF::Setup(), and wsf::comm::router::ProtocolAdHoc::ValidNetwork().

Initialize()

bool WsfComponent::Initialize ( double aSimTime )

virtual

Perform phase 1 initialization. This is called by WsfPlatform::Initialize() during phase 1 initialization of the platform. The component should complete validation of input data that could not be done by ProcessInput, as well as any other functions to prepare for simulation use (subject to the next paragraph).

The order in which components are initialized is defined by GetComponentInitializationOrder. In general a component implementation of this method should not be dependent on the state of another component, i.e.: it should not assume that the other components Initialize() method has been called. If such a dependency exists one should use Initialize2() if possible, or specify a value GetComponentInitializationOrder to force things to initialize in a particular order.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful (bad input data, etc.)

Note

This method should NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

Initialize2()

bool WsfComponent::Initialize2 ( double aSimTime )

virtual

Perform phase 2 initialization. This is called by WsfPlatform::Initialize() during phase 2 of platform initialization. This method is typically used when a component may have some dependency on another component having completed its phase 1 initialization. The component should be ready for use in the simulation upon completion of this method.

The order in which components are initialized is defined by GetComponentInitializationOrder.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful.

Note

This method MUST NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

PendingStart()

virtual void wsf::comm::router::RouterComponent::PendingStart ( )

inlinevirtual

PreInitialize()

bool WsfComponent::PreInitialize ( double aSimTime )

virtual

Perform pre-initializion function. This is called by WsfPlatform::Initialize prior to actually initializing the components on a platform (i.e.: calling Initialize and Initialize2 for each component). The primary reason for this method is to allow components to add other components that will then be subsequently initialized. The component may examine the component list and add components, but it must not assume ANYTHING about the actual state of the component.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful (bad input data, etc.)

Reimplemented from WsfComponent.

ProcessInput()

bool WsfComponent::ProcessInput ( UtInput & aInput )

virtual

Evaluate the current input command and determine if it is one processed by the component. The component should get the current command from the input stream and determine if it is one that it recognizes. If it does not recognize the command then it should leave the command in the input stream and return false. If it does recognize the command then it should process the command and return true. If invalid arguments are encountered then it should throw an exception.

Parameters

aInput

The input stream.

Returns

true if the current command was recognized (and processed), or false if the command was not recognized.

Exceptions

UtInput::ExceptionBase

if an invalid input was encountered.

Reimplemented from WsfComponent.

Setup()

virtual void wsf::comm::router::RouterComponent::Setup ( )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, and wsf::comm::router::ProtocolOSPF.

---

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

• WsfCommRouterComponent.hpp
• WsfCommRouterComponent.cpp