wsf::comm::router::ProtocolInterface Class Reference

#include <WsfCommRouterProtocolInterface.hpp>

Inheritance diagram for wsf::comm::router::ProtocolInterface:

Collaboration diagram for wsf::comm::router::ProtocolInterface:

Public Member Functions
	ProtocolInterface ()=default
	~ProtocolInterface () override=default
const char *	GetScriptClassName () const override
Public Member Functions inherited from wsf::comm::router::RouterComponent
	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 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 ()
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Required interface from WsfComponent.
WsfComponent *	CloneComponent () const override=0
WsfStringId	GetComponentName () const override final
const int *	GetComponentRoles () const override=0
void *	QueryInterface (int aRole) override=0

Required interface from WsfObject
ProtocolInterface *	Clone () const override=0

Interface from WsfCommComponent.
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override

Operator Overloads
bool	operator< (const ProtocolInterface &aRhs) const

Graph methods
If a protocol uses a graph representation, this method should return it for operations. Not all protocols have this functionality, and should return a nullptr on the GetGraph function if that is the case. The ShouldPropagateTruth function provides whether or not the router should push updates from the truth representation (the network manager) to this protocol during updates (otherwise it is up to the protocol or direct user input do accomplish this).
virtual bool	ShouldPropagateTruth () const =0
virtual graph::Graph *	GetGraph () const =0
virtual int	GetPriority () const =0
virtual std::vector< Address >	Routing (double aSimTime, const Address &aSendingInterface, size_t &aHopNumber, double &aCost, const Message &aMessage)=0

Send/Receive methods
The send and receive methods for the routing protocol provide hooks into querying each protocol for router message processing. The send method is queried, allowing the protocol to process the the message prior to a transmission. By default, this method returns true with no additional message processing. Returning false indicates an issue with this protocol not being able to process this message transmission, upon which the router will attempt the same process for other available protocols (if applicable). This method also allows the protocol to conduct internal bookkeeping when messages are sent. The receive method is called when an interface receives a message. If the destination address of the message isn't natively mapped to the receiving interface, a protocol may use a different addressing schema (such as in multicast groups). This method also allows the protocol to conduct internal bookkeeping when messages are received. This method returns true to indicate the message is intended for the current receiving interface, false if not. Any given protocol that returns false will allow other, lower priority protocols, an attempt to process this message after returning false.
virtual bool	Send (double aSimTime, Router::SendData &aData)
virtual bool	Receive (double aSimTime, const Address &aReceivingInterface, Message &aMessage, bool &aOverrideForward)

State Notifications
Some protocols may wish to take implementation defined actions based on truth state updates in the simulation via the Network Manager. These methods may be overridden, and are called during the applicable event from the router.
virtual void	PerfectCommAdded (double aSimTime, Comm *aCommPtr)
virtual void	PerfectCommRemoved (double aSimTime, Comm *aCommPtr)
virtual void	PerfectNetworkAdded (double aSimTime, Network *aNetworkPtr)
virtual void	PerfectNetworkRemoved (double aSimTime, Network *aNetworkPtr)
virtual void	PerfectCommEnabled (double aSimTime, Comm *aCommPtr)
virtual void	PerfectCommDisabled (double aSimTime, Comm *aCommPtr)
virtual void	PerfectConnectionAdded (double aSimTime, const Address &aSourceAddress, const Address &aDestinationAddress)
virtual void	PerfectConnectionRemoved (double aSimTime, const Address &aSourceAddress, const Address &aDestinationAddress)
virtual void	PerfectConnectionEnabled (double aSimTime, const Address &aSourceAddress, const Address &aDestinationAddress)
virtual void	PerfectConnectionDisabled (double aSimTime, const Address &aSourceAddress, const Address &aDestinationAddress)

Additional Inherited Members
Public Types inherited from WsfComponentT< Router >
typedef Router	ParentType
	This is needed to support the WsfComponentList template.
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

ProtocolInterface()

wsf::comm::router::ProtocolInterface::ProtocolInterface ( )

default

Referenced by Clone(), operator<(), wsf::comm::router::ProtocolAdHoc::ProtocolAdHoc(), wsf::comm::router::ProtocolOSPF::ProtocolOSPF(), wsf::comm::router::ProtocolAdHoc::QueryInterface(), wsf::comm::router::ProtocolLegacy::QueryInterface(), wsf::comm::router::ProtocolMulticast::QueryInterface(), wsf::comm::router::ProtocolOSPF::QueryInterface(), wsf::comm::router::rip::RIPv2::RIPv2(), and wsf::comm::router::ProtocolOSPF::RouteExternallyASBR().

~ProtocolInterface()

wsf::comm::router::ProtocolInterface::~ProtocolInterface ( )

overridedefault

Member Function Documentation

Clone()

ProtocolInterface * wsf::comm::router::ProtocolInterface::Clone ( ) const

overridepure virtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

References ProtocolInterface().

CloneComponent()

WsfComponent * wsf::comm::router::ProtocolInterface::CloneComponent ( ) const

overridepure virtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

GetComponentName()

WsfStringId wsf::comm::router::ProtocolInterface::GetComponentName ( ) const

inlinefinaloverridevirtual

Returns the component's name. Each component in a component list has a unique name. Names are usually defined by the user, but they may also be generated by code and prefixed with a '#' to guarantee no collisions with user-defined names.

Implements WsfComponent.

References WsfObject::GetNameId().

GetComponentRoles()

const int * wsf::comm::router::ProtocolInterface::GetComponentRoles ( ) const

overridepure virtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Implements WsfComponent.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

GetGraph()

virtual graph::Graph * wsf::comm::router::ProtocolInterface::GetGraph ( ) const

pure virtual

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Referenced by wsf::comm::router::Router::AddLink(), wsf::comm::router::Router::AddNode(), wsf::comm::router::Router::DisableLink(), wsf::comm::router::Router::DisableNode(), wsf::comm::router::Router::EnableLink(), wsf::comm::router::Router::EnableNode(), wsf::comm::router::Router::RemoveLink(), and wsf::comm::router::Router::RemoveNode().

GetPriority()

virtual int wsf::comm::router::ProtocolInterface::GetPriority ( ) const

pure virtual

Required query for protocol priority. Protocols are evaluated in order based on their assigned priorities. A lower value indicates a higher priority.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Referenced by wsf::comm::router::Router::GetSortedProtocols(), and operator<().

GetScriptClassName()

const char * wsf::comm::router::ProtocolInterface::GetScriptClassName ( ) const

inlineoverride

Initialize()

bool wsf::comm::router::ProtocolInterface::Initialize ( double aSimTime )

inlineoverridevirtual

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.

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

operator<()

bool wsf::comm::router::ProtocolInterface::operator< ( const ProtocolInterface & aRhs ) const

inline

References GetPriority(), and ProtocolInterface().

PerfectCommAdded()

virtual void wsf::comm::router::ProtocolInterface::PerfectCommAdded ( double aSimTime, Comm * aCommPtr )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolAdHoc.

PerfectCommDisabled()

virtual void wsf::comm::router::ProtocolInterface::PerfectCommDisabled ( double aSimTime, Comm * aCommPtr )

inlinevirtual

PerfectCommEnabled()

virtual void wsf::comm::router::ProtocolInterface::PerfectCommEnabled ( double aSimTime, Comm * aCommPtr )

inlinevirtual

PerfectCommRemoved()

virtual void wsf::comm::router::ProtocolInterface::PerfectCommRemoved ( double aSimTime, Comm * aCommPtr )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolAdHoc.

PerfectConnectionAdded()

virtual void wsf::comm::router::ProtocolInterface::PerfectConnectionAdded ( double aSimTime, const Address & aSourceAddress, const Address & aDestinationAddress )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolAdHoc.

PerfectConnectionDisabled()

virtual void wsf::comm::router::ProtocolInterface::PerfectConnectionDisabled ( double aSimTime, const Address & aSourceAddress, const Address & aDestinationAddress )

inlinevirtual

PerfectConnectionEnabled()

virtual void wsf::comm::router::ProtocolInterface::PerfectConnectionEnabled ( double aSimTime, const Address & aSourceAddress, const Address & aDestinationAddress )

inlinevirtual

PerfectConnectionRemoved()

virtual void wsf::comm::router::ProtocolInterface::PerfectConnectionRemoved ( double aSimTime, const Address & aSourceAddress, const Address & aDestinationAddress )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolAdHoc.

PerfectNetworkAdded()

virtual void wsf::comm::router::ProtocolInterface::PerfectNetworkAdded ( double aSimTime, Network * aNetworkPtr )

inlinevirtual

PerfectNetworkRemoved()

virtual void wsf::comm::router::ProtocolInterface::PerfectNetworkRemoved ( double aSimTime, Network * aNetworkPtr )

inlinevirtual

ProcessInput()

bool wsf::comm::router::ProtocolInterface::ProcessInput ( UtInput & aInput )

inlineoverridevirtual

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.

Reimplemented in wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Referenced by wsf::comm::router::rip::RIPv2::ProcessInput().

QueryInterface()

void * wsf::comm::router::ProtocolInterface::QueryInterface ( int aRole )

overridepure virtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole

The role whose interface is to be returned.

Returns

A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Implements WsfComponent.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Receive()

virtual bool wsf::comm::router::ProtocolInterface::Receive ( double aSimTime, const Address & aReceivingInterface, Message & aMessage, bool & aOverrideForward )

inlinevirtual

Reimplemented in wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Routing()

virtual std::vector< Address > wsf::comm::router::ProtocolInterface::Routing ( double aSimTime, const Address & aSendingInterface, size_t & aHopNumber, double & aCost, const Message & aMessage )

pure virtual

The routing method is used by the router to determine the route based on the protocol defined routing algorithm. A return of an empty vector indicates that no path was found. The router will utilize any of its available interfaces to find a valid path.

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

Referenced by wsf::comm::router::ProtocolOSPF::RouteExternallyASBR().

Send()

virtual bool wsf::comm::router::ProtocolInterface::Send ( double aSimTime, Router::SendData & aData )

inlinevirtual

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

ShouldPropagateTruth()

virtual bool wsf::comm::router::ProtocolInterface::ShouldPropagateTruth ( ) const

pure virtual

Implemented in wsf::comm::router::ProtocolAdHoc, wsf::comm::router::ProtocolLegacy, wsf::comm::router::ProtocolMulticast, wsf::comm::router::ProtocolOSPF, and wsf::comm::router::rip::RIPv2.

---

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

• WsfCommRouterProtocolInterface.hpp