WsfScriptCommClass.cpp File Reference

#include "script/WsfScriptCommClass.hpp"
#include "UtLog.hpp"
#include "WsfComm.hpp"
#include "WsfCommAddress.hpp"
#include "WsfCommComponentHW.hpp"
#include "WsfCommGraph.hpp"
#include "WsfCommMedium.hpp"
#include "WsfCommMediumContainer.hpp"
#include "WsfCommNetworkLayer.hpp"
#include "WsfCommNetworkManager.hpp"
#include "WsfCommProtocolInterface.hpp"
#include "WsfCommRouter.hpp"
#include "WsfCommTypes.hpp"
#include "WsfCommUtil.hpp"
#include "WsfCommandChain.hpp"
#include "WsfEM_Rcvr.hpp"
#include "WsfEM_Xmtr.hpp"
#include "WsfPlatform.hpp"
#include "WsfSimulation.hpp"
#include "WsfStringId.hpp"
#include "script/WsfScriptCommAddress.hpp"
#include "script/WsfScriptContext.hpp"
#include "script/WsfScriptDefs.hpp"

Include dependency graph for WsfScriptCommClass.cpp:

Functions
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, WsfScriptCommClass, IsA_TypeOf, 2, "bool", "string, string")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, WsfScriptCommClass, GetComm, 1, "WsfComm", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD_NOCHECK (WsfScriptCommClass, wsf::comm::Comm, TurnOff, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD_NOCHECK (WsfScriptCommClass, wsf::comm::Comm, TurnOn, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, NetworkName, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, GetAddress, 0, "WsfAddress", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, GetRouter, 0, "WsfCommRouter", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, GetMedium, 0, "WsfCommMedium", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, IsConnectedTo_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, IsConnectedTo_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, PathExistsTo_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, PathExistsTo_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, IsConnectionEnabled_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, IsConnectionEnabled_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, EnableConnection_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, EnableConnection_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, DisableConnection_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, DisableConnection_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, AddConnection_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, AddConnection_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, RemoveConnection_1, 1, "bool", "WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, RemoveConnection_2, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessage_1, 2, "void", "WsfMessage, WsfComm")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessage_2, 3, "void", "WsfMessage, string, string")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessage_3, 2, "void", "WsfMessage, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessageToCommander_1, 2, "void", "string, WsfMessage")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessageToCommander_2, 1, "void", "WsfMessage")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessageToPeers, 2, "void", "string, WsfMessage")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, SendMessageToSubordinates, 2, "void", "string, WsfMessage")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, CanSendTo, 1, "bool", "WsfComm")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, Xmtr, 1, "WsfEM_Xmtr", "int")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, XmtrCount, 0, "int", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, Rcvr, 1, "WsfEM_Rcvr", "int")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommClass, wsf::comm::Comm, RcvrCount, 0, "int", "")

Function Documentation

UT_DEFINE_SCRIPT_METHOD() [1/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		AddConnection_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

If both comms are members of the same network, we use the network API to enable the connection. This allows the network to either accept or reject the connection based off its implementation, topology, etc.

This is an inter-network connection. Simply add the connection between the members.

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [2/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		AddConnection_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

If both comms are members of the same network, we use the network API to enable the connection. This allows the network to either accept or reject the connection based off its implementation, topology, etc.

This is an inter-network connection. Simply add the connection between the members.

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [3/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		CanSendTo	,
		1	,
		"bool"	,
		"WsfComm"	)

References wsf::comm::Comm::CanSendTo(), and TIME_NOW.

UT_DEFINE_SCRIPT_METHOD() [4/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		DisableConnection_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [5/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		DisableConnection_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [6/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		EnableConnection_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [7/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		EnableConnection_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [8/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		GetAddress	,
		0	,
		"WsfAddress"	,
		""	)

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

UT_DEFINE_SCRIPT_METHOD() [9/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		GetMedium	,
		0	,
		"WsfCommMedium"	,
		""	)

References wsf::comm::medium::ContainerComponent< PARENT >::Find().

UT_DEFINE_SCRIPT_METHOD() [10/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		GetRouter	,
		0	,
		"WsfCommRouter"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [11/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		IsConnectedTo_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [12/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		IsConnectedTo_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [13/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		IsConnectionEnabled_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [14/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		IsConnectionEnabled_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [15/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		NetworkName	,
		0	,
		"string"	,
		""	)

References WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [16/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		PathExistsTo_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [17/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		PathExistsTo_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [18/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		Rcvr	,
		1	,
		"WsfEM_Rcvr"	,
		"int"	)

References wsf::comm::ComponentHW::Find().

UT_DEFINE_SCRIPT_METHOD() [19/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		RcvrCount	,
		0	,
		"int"	,
		""	)

References wsf::comm::ComponentHW::Find().

UT_DEFINE_SCRIPT_METHOD() [20/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		RemoveConnection_1	,
		1	,
		"bool"	,
		"WsfAddress"	)

If both comms are members of the same network, we use the network API to enable the connection. This allows the network to either accept or reject the connection based off its implementation, topology, etc.

This is an inter-network connection. Simply remove the connection between the members.

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [21/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		RemoveConnection_2	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

If both comms are members of the same network, we use the network API to enable the connection. This allows the network to either accept or reject the connection based off its implementation, topology, etc.

This is an inter-network connection. Simply add the connection between the members.

References SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [22/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessage_1	,
		2	,
		"void"	,
		"	WsfMessage,
		WsfComm"	)

References WsfScriptContext::GetTIME_NOW(), simTime, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [23/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessage_2	,
		3	,
		"void"	,
		"	WsfMessage,
		string	,
		string"	)

References platformPtr, SIMULATION, TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [24/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessage_3	,
		2	,
		"void"	,
		"	WsfMessage,
		WsfAddress"	)

References TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [25/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessageToCommander_1	,
		2	,
		"void"	,
		"	string,
		WsfMessage"	)

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfCommandChain::GetCommander(), WsfCommandChain::GetDefaultName(), WsfCommandChain::GetPlatform(), platformPtr, TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [26/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessageToCommander_2	,
		1	,
		"void"	,
		"WsfMessage"	)

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfCommandChain::GetCommander(), WsfCommandChain::GetDefaultNameId(), WsfCommandChain::GetPlatform(), platformPtr, TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [27/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessageToPeers	,
		2	,
		"void"	,
		"	string,
		WsfMessage"	)

References WsfComponentList::RoleIterator< T >::AtEnd(), wsf::comm::util::cPEERS, WsfCommandChain::GetDefaultNameId(), WsfCommandChain::GetPlatform(), wsf::comm::util::SelectRecipients(), TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [28/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		SendMessageToSubordinates	,
		2	,
		"void"	,
		"	string,
		WsfMessage"	)

References WsfComponentList::RoleIterator< T >::AtEnd(), wsf::comm::util::cSUBORDINATES, WsfCommandChain::GetDefaultNameId(), WsfCommandChain::GetPlatform(), wsf::comm::util::SelectRecipients(), TIME_NOW, and WSF_SCRIPT_WARN_INIT.

UT_DEFINE_SCRIPT_METHOD() [29/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		Xmtr	,
		1	,
		"WsfEM_Xmtr"	,
		"int"	)

References wsf::comm::ComponentHW::Find(), and wsf::comm::ComponentHW::GetEM_Xmtr().

UT_DEFINE_SCRIPT_METHOD() [30/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		XmtrCount	,
		0	,
		"int"	,
		""	)

References wsf::comm::ComponentHW::Find(), and wsf::comm::ComponentHW::GetEM_XmtrCount().

UT_DEFINE_SCRIPT_METHOD() [31/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		WsfScriptCommClass	,
		GetComm	,
		1	,
		"WsfComm"	,
		"WsfAddress"	)

References SIMULATION, and WSF_SCRIPT_WARN_INIT_NOT_INIT2.

UT_DEFINE_SCRIPT_METHOD() [32/32]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommClass	,
		WsfScriptCommClass	,
		IsA_TypeOf	,
		2	,
		"bool"	,
		"	string,
		string"	)

References WsfObjectTypeList< T >::Find(), wsf::comm::Types::Get(), and WsfObject::IsA_TypeOf().

UT_DEFINE_SCRIPT_METHOD_NOCHECK() [1/2]

UT_DEFINE_SCRIPT_METHOD_NOCHECK	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		TurnOff	,
		0	,
		"bool"	,
		""	)

References ok, SIMULATION, and TIME_NOW.

UT_DEFINE_SCRIPT_METHOD_NOCHECK() [2/2]

UT_DEFINE_SCRIPT_METHOD_NOCHECK	(	WsfScriptCommClass	,
		wsf::comm::Comm	,
		TurnOn	,
		0	,
		"bool"	,
		""	)

References ok, SIMULATION, and TIME_NOW.