wsf::comm Namespace Reference

Namespaces
namespace	router
namespace	graph
namespace	layer
namespace	medium
namespace	reserved
namespace	util

Classes
class	Comm
struct	IPv4
class	Address
class	ApplicationLayer
class	Component
class	ComponentHW
	The hardware component that can be attached to all comm systems. More...
class	DatalinkLayer
class	Event
	An event associated with communications (transfer complete, etc). More...
class	GenericEvent
class	Layer
class	LayerImp
	A base class defining the interface for the implementation classes. (Implementor). More...
class	LayerEvent
class	MessageHeader
class	MessageTrailer
class	Message
class	ScriptMessageClass
class	Network
class	ScriptNetworkClass
class	NetworkAdHoc
class	ScriptNetworkAdHocClass
class	NetworkGeneric
class	ScriptNetworkGenericClass
class	NetworkLayer
class	NetworkManager
class	NetworkManagerExtension
class	NetworkMesh
class	NetworkMeshLegacy
class	ScriptNetworkMeshClass
class	ScriptNetworkMeshLegacyClass
class	NetworkPointToPoint
class	ScriptNetworkPointToPointClass
class	NetworkRing
class	NetworkDirectedRing
class	ScriptNetworkRingClass
class	ScriptNetworkDirectedRingClass
class	NetworkStar
class	ScriptNetworkStarClass
class	NetworkTypes
class	PhysicalLayer
class	PresentationLayer
class	ProtocolIGMP
class	IGMP_SubscriptionEvent
	An event class for handling join/leave multicast delays. More...
class	ScriptProtocolClassIGMP
	Script class for this protocol. More...
class	ProtocolInterface
class	ScriptProtocolClass
	Base interface script class. More...
class	ProtocolStack
	This class represents a communication devices protocol stack. More...
class	ProtocolTypes
class	Queue
class	ReservedAddressingImplementation
class	ReservedAddressing
class	ReservedAddressBase
class	Result
class	LeastHops
class	EdgeWeight
class	InverseEdgeWeight
class	SessionLayer
class	TransportLayer
class	Types
class	XmtrRcvr
class	RadioXmtrRcvr
class	ComponentHW_JTIDS
	The hardware component that can be attached to all comm systems. More...
class	ComponentHW_LASER
class	ComponentHW_Subsurface
	The hardware component that can be attached to all comm systems. More...
class	PhysicalLayerJTIDS
class	PhysicalLayerLaser
class	SlotGroupLayerJTIDS
class	LASER_XmtrRcvr

Enumerations
enum class	ProtocolPriority : int {   cAD_HOC = 0 , cRIPv2 = 100 , cOSPF = 200 , cIGMP = 300 ,   cMULTICAST = 400 , cLEGACY = 500 }

Functions
std::ostream &	operator<< (std::ostream &aOut, const Address &aAddress)
	UT_DEFINE_SCRIPT_METHOD (ScriptMessageClass, Message, GetTraceRoute, 0, "Array<WsfAddress>", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptMessageClass, Message, GetTTL, 0, "int", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptMessageClass, Message, GetSourceMessage, 0, "WsfMessage", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetAddress, 0, "WsfAddress", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, SetAddress, 1, "void", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetName, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, SetName, 1, "void", "string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, AddMember_1, 1, "bool", "WsfComm")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, AddMember_2, 2, "bool", "string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, RemoveMember_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, RemoveMember_2, 2, "bool", "string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, AddLink_1, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, AddLink_2, 4, "bool", "string, string, string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, RemoveLink_1, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, RemoveLink_2, 4, "bool", "string, string, string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetMembers, 0, "Array<WsfAddress>", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, AddNetwork, 1, "bool", "WsfNetwork")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, RemoveNetwork, 1, "void", "WsfNetwork")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetNetwork_1, 1, "WsfNetwork", "string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetNetwork_2, 1, "WsfNetwork", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkClass, Network, GetManagedNetworks, 0, "Array<string>", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkAdHocClass, NetworkAdHoc, ChangeUpdateRate, 1, "void", "WsfRandomVariable")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkAdHocClass, NetworkAdHoc, AddMemberUpdateRate, 2, "bool", "WsfAddress, WsfRandomVariable")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkAdHocClass, NetworkAdHoc, RemoveMemberUpdateRate, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkStarClass, NetworkStar, AddHub_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkStarClass, NetworkStar, AddHub_2, 2, "bool", "string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkStarClass, NetworkStar, RemoveHub_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptNetworkStarClass, NetworkStar, RemoveHub_2, 2, "bool", "string, string")
	UT_DEFINE_SCRIPT_METHOD (ScriptProtocolClassIGMP, ProtocolIGMP, JoinMulticastGroup, 1, "void", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (ScriptProtocolClassIGMP, ProtocolIGMP, LeaveMulticastGroup, 1, "void", "WsfAddress")

Variables
static const Address &	cMulticastRange {"224.0.0.0", 4u}

Enumeration Type Documentation

ProtocolPriority

enum class wsf::comm::ProtocolPriority : int

strong

An enum that is centrally located for assignment of protocol priorities. These are held in a single location for ease of inspection of relative priorities of differing comm protocols.

Enumerator
cAD_HOC
cRIPv2
cOSPF
cIGMP
cMULTICAST
cLEGACY

Function Documentation

operator<<()

std::ostream & wsf::comm::operator<<	(	std::ostream &	aOut,
		const Address &	aAddress )

UT_DEFINE_SCRIPT_METHOD() [1/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptMessageClass	,
		Message	,
		GetSourceMessage	,
		0	,
		"WsfMessage"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [2/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptMessageClass	,
		Message	,
		GetTraceRoute	,
		0	,
		"Array<WsfAddress>"	,
		""	)

References WsfScriptCommAddressClass::Create().

UT_DEFINE_SCRIPT_METHOD() [3/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptMessageClass	,
		Message	,
		GetTTL	,
		0	,
		"int"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [4/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkAdHocClass	,
		NetworkAdHoc	,
		AddMemberUpdateRate	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfRandomVariable"	)

References WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), wsf::comm::Network::NamedComm::mCommName, wsf::comm::Network::NamedComm::mPlatformName, and SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [5/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkAdHocClass	,
		NetworkAdHoc	,
		ChangeUpdateRate	,
		1	,
		"void"	,
		"WsfRandomVariable"	)

References SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [6/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkAdHocClass	,
		NetworkAdHoc	,
		RemoveMemberUpdateRate	,
		1	,
		"bool"	,
		"WsfAddress"	)

UT_DEFINE_SCRIPT_METHOD() [7/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		AddLink_1	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [8/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		AddLink_2	,
		4	,
		"bool"	,
		"	string,
		string	,
		string	,
		string"	)

References wsf::comm::Network::GetAddressFromNamedComm(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [9/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		AddMember_1	,
		1	,
		"bool"	,
		"WsfComm"	)

References wsf::comm::NetworkManager::AddComm(), WsfSimulation::GetCommNetworkManager(), WsfSimulation::GetSimTime(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [10/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		AddMember_2	,
		2	,
		"bool"	,
		"	string,
		string"	)

References wsf::comm::NetworkManager::AddComm(), WsfSimulation::GetCommNetworkManager(), WsfComponentList::GetComponent(), WsfSimulation::GetPlatformByName(), WsfSimulation::GetSimTime(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [11/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		AddNetwork	,
		1	,
		"bool"	,
		"WsfNetwork"	)

References WsfSimulation::GetCommNetworkManager(), WsfSimulation::GetSimTime(), WsfScriptContext::GetSIMULATION(), success, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [12/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetAddress	,
		0	,
		"WsfAddress"	,
		""	)

References WsfScriptCommAddressClass::Create(), wsf::comm::Address::GetAddress(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [13/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetManagedNetworks	,
		0	,
		"Array<string>"	,
		""	)

References WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [14/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetMembers	,
		0	,
		"Array<WsfAddress>"	,
		""	)

References WsfScriptCommAddressClass::Create(), WsfSimulation::GetCommNetworkManager(), WsfScriptContext::GetSIMULATION(), and WsfObject::GetType().

UT_DEFINE_SCRIPT_METHOD() [15/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetName	,
		0	,
		"string"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [16/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetNetwork_1	,
		1	,
		"WsfNetwork"	,
		"string"	)

References WsfSimulation::GetCommNetworkManager(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [17/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		GetNetwork_2	,
		1	,
		"WsfNetwork"	,
		"WsfAddress"	)

References WsfSimulation::GetCommNetworkManager(), wsf::comm::NetworkManager::GetNetworkNameFromAddress(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [18/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		RemoveLink_1	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [19/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		RemoveLink_2	,
		4	,
		"bool"	,
		"	string,
		string	,
		string	,
		string"	)

References wsf::comm::Network::GetAddressFromNamedComm(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [20/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		RemoveMember_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References wsf::comm::NetworkManager::GetComm(), WsfSimulation::GetCommNetworkManager(), WsfSimulation::GetSimTime(), WsfScriptContext::GetSIMULATION(), wsf::comm::NetworkManager::IsCommManaged(), wsf::comm::NetworkManager::RemoveComm(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [21/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		RemoveMember_2	,
		2	,
		"bool"	,
		"	string,
		string"	)

References wsf::comm::Network::GetAddressFromNamedComm(), wsf::comm::NetworkManager::GetComm(), WsfSimulation::GetCommNetworkManager(), WsfSimulation::GetSimTime(), WsfScriptContext::GetSIMULATION(), wsf::comm::NetworkManager::IsCommManaged(), wsf::comm::NetworkManager::RemoveComm(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [22/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		RemoveNetwork	,
		1	,
		"void"	,
		"WsfNetwork"	)

References WsfScriptContext::GetSIMULATION(), WsfObject::GetType(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [23/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		SetAddress	,
		1	,
		"void"	,
		"WsfAddress"	)

References wsf::comm::Address::SetAddress(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [24/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkClass	,
		Network	,
		SetName	,
		1	,
		"void"	,
		"string"	)

UT_DEFINE_SCRIPT_METHOD() [25/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkStarClass	,
		NetworkStar	,
		AddHub_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [26/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkStarClass	,
		NetworkStar	,
		AddHub_2	,
		2	,
		"bool"	,
		"	string,
		string"	)

References wsf::comm::Network::GetAddressFromNamedComm(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [27/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkStarClass	,
		NetworkStar	,
		RemoveHub_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [28/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptNetworkStarClass	,
		NetworkStar	,
		RemoveHub_2	,
		2	,
		"bool"	,
		"	string,
		string"	)

References wsf::comm::Network::GetAddressFromNamedComm(), WsfScriptContext::GetSIMULATION(), and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [29/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptProtocolClassIGMP	,
		ProtocolIGMP	,
		JoinMulticastGroup	,
		1	,
		"void"	,
		"WsfAddress"	)

References WsfScriptContext::GetTIME_NOW().

UT_DEFINE_SCRIPT_METHOD() [30/30]

wsf::comm::UT_DEFINE_SCRIPT_METHOD	(	ScriptProtocolClassIGMP	,
		ProtocolIGMP	,
		LeaveMulticastGroup	,
		1	,
		"void"	,
		"WsfAddress"	)

References WsfScriptContext::GetTIME_NOW().

Variable Documentation

cMulticastRange

const Address& wsf::comm::cMulticastRange {"224.0.0.0", 4u}

static

Referenced by wsf::comm::ProtocolIGMP::NetworkReceive(), wsf::comm::ProtocolIGMP::NetworkSend(), and wsf::comm::ProtocolIGMP::PhysicalReceive().