WsfScriptCommAddress.cpp File Reference

#include "WsfScriptCommAddress.hpp"
#include "UtMemory.hpp"

Include dependency graph for WsfScriptCommAddress.cpp:

Functions
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, WithinRange, 2, "bool", "WsfAddress, WsfAddress")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, SetAddress, 2, "bool", "string, int")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, GetAddress, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, SubnetMaskBitSize, 0, "int", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, RoutingPrefix, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, Subnet, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, PossibleHosts, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, IsNull, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, Increment, 0, "void", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, IntegerValue, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, AddressToken, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptCommAddressClass, wsf::comm::Address, GetBroadcastAddress, 0, "string", "")

Function Documentation

UT_DEFINE_SCRIPT_METHOD() [1/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		AddressToken	,
		0	,
		"string"	,
		""	)

References wsf::comm::Address::GetGenerationToken().

UT_DEFINE_SCRIPT_METHOD() [2/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		GetAddress	,
		0	,
		"string"	,
		""	)

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

UT_DEFINE_SCRIPT_METHOD() [3/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		GetBroadcastAddress	,
		0	,
		"string"	,
		""	)

References wsf::comm::Address::GetBroadcastAddress().

UT_DEFINE_SCRIPT_METHOD() [4/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		Increment	,
		0	,
		"void"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [5/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		IntegerValue	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [6/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		IsNull	,
		0	,
		"bool"	,
		""	)

References wsf::comm::Address::IsNull().

UT_DEFINE_SCRIPT_METHOD() [7/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		PossibleHosts	,
		0	,
		"double"	,
		""	)

Note: Since we don't have unsigned return types, we're forced to use a double since the return value may exceed the limit of a signed integer.

References wsf::comm::Address::GetNumHostAddresses().

UT_DEFINE_SCRIPT_METHOD() [8/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		RoutingPrefix	,
		0	,
		"string"	,
		""	)

References wsf::comm::Address::GetRoutingPrefix().

UT_DEFINE_SCRIPT_METHOD() [9/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		SetAddress	,
		2	,
		"bool"	,
		"	string,
		int"	)

Ensure the integer value is positive.

References wsf::comm::Address::IsNull(), wsf::comm::Address::SetAddress(), and success.

UT_DEFINE_SCRIPT_METHOD() [10/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		Subnet	,
		0	,
		"string"	,
		""	)

References wsf::comm::Address::GetSubnet().

UT_DEFINE_SCRIPT_METHOD() [11/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		SubnetMaskBitSize	,
		0	,
		"int"	,
		""	)

References wsf::comm::Address::GetSubnetMaskBitLength().

UT_DEFINE_SCRIPT_METHOD() [12/12]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptCommAddressClass	,
		wsf::comm::Address	,
		WithinRange	,
		2	,
		"bool"	,
		"	WsfAddress,
		WsfAddress"	)

References wsf::comm::Address::CheckInAddressRange().