WsfNetworkInterface Class Reference

#include <WsfNetworkInterface.hpp>

Inheritance diagram for WsfNetworkInterface:

Collaboration diagram for WsfNetworkInterface:

Public Member Functions
	WsfNetworkInterface (WsfSimulation &aSimulation, const std::string &aName, const WsfNetworkInterfaceInput &aNetInput)
virtual	~WsfNetworkInterface ()
virtual bool	Initialize ()
virtual void	NetworkUpdate (double aSimTime)=0
double	GetUpdateInterval () const
void	SetUpdateInterval (double aUpdateInterval)
void	SetUpdateOnExternalTimer (bool aUseExternalTimer)
bool	IsActive () const
bool	IsDebug () const
void	SetDebug (bool aIsDebug)
void	SetUDP_Addr (const std::string &aUDP_Addr)
void	SetSendPort (int aSendPort)
void	SetRecvPort (int aRecvPort)
WsfSimulation &	GetSimulation ()

Protected Member Functions
virtual void	PrivateInitialize ()
Protected Member Functions inherited from WsfNetworkInterfaceInput
	WsfNetworkInterfaceInput (WsfScenario &aScenario)
bool	ProcessNetworkInput (UtInput &aInput)

Protected Attributes
WsfSimulation *	mSimulationPtr
std::string	mName
GenNetIO *	mIOPtr
GenTCP_IO *	mTCP_IOPtr
GenUDP_IO *	mUDP_IOPtr
GenTCP_Server	mTCP_Server
UtCallbackHolder	mCallbacks
Protected Attributes inherited from WsfNetworkInterfaceInput
WsfScenario *	mScenarioPtr
bool	mIsRequested
bool	mIsDisabled
bool	mDebug
std::string	mUDP_Addr
std::string	mUDP_Interface
std::string	mTCP_Addr
int	mTTL
int	mSendPort
int	mReceivePort
double	mUpdateInterval
bool	mUpdateOnAdvanceTime
bool	mUpdateOnExternalTimer

Detailed Description

WsfNetworkInterface is a general-purpose network interface for TCP client or server, or UDP connections. It uses the abstract features of the GenIO library in an extensible base class. To use this class, extend the "NetworkUpdate" method to perform custom processing.

Constructor & Destructor Documentation

WsfNetworkInterface()

WsfNetworkInterface::WsfNetworkInterface	(	WsfSimulation &	aSimulation,
		const std::string &	aName,
		const WsfNetworkInterfaceInput &	aNetInput )

References Initialize(), WsfObserver::Initialize(), mCallbacks, mIOPtr, mName, mSimulationPtr, mTCP_IOPtr, mTCP_Server, mUDP_IOPtr, and WsfNetworkInterfaceInput::WsfNetworkInterfaceInput().

~WsfNetworkInterface()

WsfNetworkInterface::~WsfNetworkInterface ( )

virtual

References mCallbacks, mTCP_IOPtr, and mUDP_IOPtr.

Member Function Documentation

GetSimulation()

WsfSimulation & WsfNetworkInterface::GetSimulation ( )

inline

References mSimulationPtr.

GetUpdateInterval()

double WsfNetworkInterface::GetUpdateInterval ( ) const

inline

References WsfNetworkInterfaceInput::mUpdateInterval.

Initialize()

bool WsfNetworkInterface::Initialize ( )

virtual

References WsfObserver::AdvanceTime(), mCallbacks, mIOPtr, WsfNetworkInterfaceInput::mIsDisabled, WsfNetworkInterfaceInput::mIsRequested, mName, WsfNetworkInterfaceInput::mReceivePort, WsfNetworkInterfaceInput::mSendPort, mSimulationPtr, WsfNetworkInterfaceInput::mTCP_Addr, mTCP_IOPtr, mTCP_Server, WsfNetworkInterfaceInput::mTTL, WsfNetworkInterfaceInput::mUDP_Addr, WsfNetworkInterfaceInput::mUDP_Interface, mUDP_IOPtr, WsfNetworkInterfaceInput::mUpdateOnAdvanceTime, WsfNetworkInterfaceInput::mUpdateOnExternalTimer, NetworkUpdate(), and PrivateInitialize().

Referenced by WsfNetworkInterface().

IsActive()

bool WsfNetworkInterface::IsActive

(

)

const

References WsfNetworkInterfaceInput::mIsDisabled, mTCP_IOPtr, and mUDP_IOPtr.

IsDebug()

bool WsfNetworkInterface::IsDebug ( ) const

inline

References WsfNetworkInterfaceInput::mDebug.

NetworkUpdate()

virtual void WsfNetworkInterface::NetworkUpdate ( double aSimTime )

pure virtual

Referenced by Initialize().

PrivateInitialize()

virtual void WsfNetworkInterface::PrivateInitialize ( )

inlineprotectedvirtual

Referenced by Initialize().

SetDebug()

void WsfNetworkInterface::SetDebug ( bool aIsDebug )

inline

References WsfNetworkInterfaceInput::mDebug.

SetRecvPort()

void WsfNetworkInterface::SetRecvPort ( int aRecvPort )

inline

References WsfNetworkInterfaceInput::mReceivePort.

SetSendPort()

void WsfNetworkInterface::SetSendPort ( int aSendPort )

inline

References WsfNetworkInterfaceInput::mSendPort.

SetUDP_Addr()

void WsfNetworkInterface::SetUDP_Addr ( const std::string & aUDP_Addr )

inline

References WsfNetworkInterfaceInput::mUDP_Addr.

SetUpdateInterval()

void WsfNetworkInterface::SetUpdateInterval ( double aUpdateInterval )

inline

References WsfNetworkInterfaceInput::mUpdateInterval.

SetUpdateOnExternalTimer()

void WsfNetworkInterface::SetUpdateOnExternalTimer ( bool aUseExternalTimer )

inline

References WsfNetworkInterfaceInput::mUpdateOnExternalTimer.

Member Data Documentation

mCallbacks

UtCallbackHolder WsfNetworkInterface::mCallbacks

protected

Referenced by Initialize(), WsfNetworkInterface(), and ~WsfNetworkInterface().

mIOPtr

GenNetIO* WsfNetworkInterface::mIOPtr

protected

Referenced by Initialize(), and WsfNetworkInterface().

mName

std::string WsfNetworkInterface::mName

protected

Referenced by Initialize(), and WsfNetworkInterface().

mSimulationPtr

WsfSimulation* WsfNetworkInterface::mSimulationPtr

protected

Referenced by GetSimulation(), Initialize(), and WsfNetworkInterface().

mTCP_IOPtr

GenTCP_IO* WsfNetworkInterface::mTCP_IOPtr

protected

Referenced by Initialize(), IsActive(), WsfNetworkInterface(), and ~WsfNetworkInterface().

mTCP_Server

GenTCP_Server WsfNetworkInterface::mTCP_Server

protected

Referenced by Initialize(), and WsfNetworkInterface().

mUDP_IOPtr

GenUDP_IO* WsfNetworkInterface::mUDP_IOPtr

protected

Referenced by Initialize(), IsActive(), WsfNetworkInterface(), and ~WsfNetworkInterface().

---

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

• WsfNetworkInterface.hpp
• WsfNetworkInterface.cpp