wsf::comm::ScriptNetworkClass Class Reference

#include <WsfCommNetwork.hpp>

Inheritance diagram for wsf::comm::ScriptNetworkClass:

Public Member Functions
	ScriptNetworkClass (const std::string &aClassName, UtScriptTypes *aTypesPtr)
std::string	ToString (void *aObjectPtr) const override
	UT_DECLARE_SCRIPT_METHOD (GetAddress)
	UT_DECLARE_SCRIPT_METHOD (GetName)
	UT_DECLARE_SCRIPT_METHOD (SetName)
	UT_DECLARE_SCRIPT_METHOD (SetAddress)
	UT_DECLARE_SCRIPT_METHOD (AddMember_1)
	UT_DECLARE_SCRIPT_METHOD (AddMember_2)
	UT_DECLARE_SCRIPT_METHOD (RemoveMember_1)
	UT_DECLARE_SCRIPT_METHOD (RemoveMember_2)
	UT_DECLARE_SCRIPT_METHOD (AddLink_1)
	UT_DECLARE_SCRIPT_METHOD (AddLink_2)
	UT_DECLARE_SCRIPT_METHOD (RemoveLink_1)
	UT_DECLARE_SCRIPT_METHOD (RemoveLink_2)
	UT_DECLARE_SCRIPT_METHOD (GetMembers)
	UT_DECLARE_SCRIPT_METHOD (AddNetwork)
	UT_DECLARE_SCRIPT_METHOD (RemoveNetwork)
	UT_DECLARE_SCRIPT_METHOD (GetNetwork_1)
	UT_DECLARE_SCRIPT_METHOD (GetNetwork_2)
	UT_DECLARE_SCRIPT_METHOD (GetManagedNetworks)

Static Protected Member Functions
template<typename T>
static void	DestroyHelper (void *aNetworkPtr)

Detailed Description

A base script class with the required interface for network script objects. The script interface prevents from using this class as an abstract base.

Constructor & Destructor Documentation

ScriptNetworkClass()

wsf::comm::ScriptNetworkClass::ScriptNetworkClass	(	const std::string &	aClassName,
		UtScriptTypes *	aTypesPtr )

Referenced by wsf::comm::ScriptNetworkGenericClass::ScriptNetworkGenericClass(), wsf::comm::ScriptNetworkMeshClass::ScriptNetworkMeshClass(), wsf::comm::ScriptNetworkPointToPointClass::ScriptNetworkPointToPointClass(), wsf::comm::ScriptNetworkRingClass::ScriptNetworkRingClass(), and wsf::comm::ScriptNetworkStarClass::ScriptNetworkStarClass().

Member Function Documentation

DestroyHelper()

template<typename T>

void wsf::comm::ScriptNetworkClass::DestroyHelper ( void * aNetworkPtr )

inlinestaticprotected

Typically, network objects are expected to be added to the simulation's network manager for handling any allocated memory. However, this may not be ultimately the case, and as such, we would have a memory leak. The DestroyHelper method will validate the network object has not been transferred ownership to the network manager before deleting for correct management of allocated memory of network objects.

Referenced by wsf::comm::ScriptNetworkAdHocClass::Destroy(), wsf::comm::ScriptNetworkDirectedRingClass::Destroy(), wsf::comm::ScriptNetworkGenericClass::Destroy(), wsf::comm::ScriptNetworkMeshClass::Destroy(), wsf::comm::ScriptNetworkMeshLegacyClass::Destroy(), wsf::comm::ScriptNetworkPointToPointClass::Destroy(), wsf::comm::ScriptNetworkRingClass::Destroy(), and wsf::comm::ScriptNetworkStarClass::Destroy().

ToString()

std::string wsf::comm::ScriptNetworkClass::ToString ( void * aObjectPtr ) const

override

References wsf::comm::Network::GetAddress().

UT_DECLARE_SCRIPT_METHOD() [1/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

AddLink_1

)

UT_DECLARE_SCRIPT_METHOD() [2/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

AddLink_2

)

UT_DECLARE_SCRIPT_METHOD() [3/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

AddMember_1

)

UT_DECLARE_SCRIPT_METHOD() [4/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

AddMember_2

)

UT_DECLARE_SCRIPT_METHOD() [5/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

AddNetwork

)

UT_DECLARE_SCRIPT_METHOD() [6/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetAddress

)

UT_DECLARE_SCRIPT_METHOD() [7/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetManagedNetworks

)

UT_DECLARE_SCRIPT_METHOD() [8/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetMembers

)

UT_DECLARE_SCRIPT_METHOD() [9/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetName

)

UT_DECLARE_SCRIPT_METHOD() [10/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetNetwork_1

)

UT_DECLARE_SCRIPT_METHOD() [11/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

GetNetwork_2

)

UT_DECLARE_SCRIPT_METHOD() [12/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

RemoveLink_1

)

UT_DECLARE_SCRIPT_METHOD() [13/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

RemoveLink_2

)

UT_DECLARE_SCRIPT_METHOD() [14/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

RemoveMember_1

)

UT_DECLARE_SCRIPT_METHOD() [15/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

RemoveMember_2

)

UT_DECLARE_SCRIPT_METHOD() [16/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

RemoveNetwork

)

UT_DECLARE_SCRIPT_METHOD() [17/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

SetAddress

)

UT_DECLARE_SCRIPT_METHOD() [18/18]

wsf::comm::ScriptNetworkClass::UT_DECLARE_SCRIPT_METHOD

(

SetName

)

---

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

• WsfCommNetwork.hpp
• WsfCommNetwork.cpp