Define script methods for WsfComm. More...

#include <WsfScriptCommClass.hpp>

Inheritance diagram for WsfScriptCommClass:

[legend]

Collaboration diagram for WsfScriptCommClass:

[legend]

Public Member Functions
	UT_DECLARE_SCRIPT_METHOD (IsA_TypeOf)
	WsfScriptCommClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
	UT_DECLARE_SCRIPT_METHOD (TurnOff)
	UT_DECLARE_SCRIPT_METHOD (TurnOn)
	UT_DECLARE_SCRIPT_METHOD (NetworkName)
	UT_DECLARE_SCRIPT_METHOD (GetAddress)
	UT_DECLARE_SCRIPT_METHOD (GetRouter)
	UT_DECLARE_SCRIPT_METHOD (GetComm)
	Network Manager pass-through.
	UT_DECLARE_SCRIPT_METHOD (GetMedium)
	Medium script API accessor.
	UT_DECLARE_SCRIPT_METHOD (IsConnectedTo_1)
	Connection methods.
	UT_DECLARE_SCRIPT_METHOD (IsConnectedTo_2)
	UT_DECLARE_SCRIPT_METHOD (PathExistsTo_1)
	UT_DECLARE_SCRIPT_METHOD (PathExistsTo_2)
	UT_DECLARE_SCRIPT_METHOD (IsConnectionEnabled_1)
	UT_DECLARE_SCRIPT_METHOD (IsConnectionEnabled_2)
	UT_DECLARE_SCRIPT_METHOD (EnableConnection_1)
	UT_DECLARE_SCRIPT_METHOD (EnableConnection_2)
	UT_DECLARE_SCRIPT_METHOD (DisableConnection_1)
	UT_DECLARE_SCRIPT_METHOD (DisableConnection_2)
	UT_DECLARE_SCRIPT_METHOD (AddConnection_1)
	UT_DECLARE_SCRIPT_METHOD (AddConnection_2)
	UT_DECLARE_SCRIPT_METHOD (RemoveConnection_1)
	UT_DECLARE_SCRIPT_METHOD (RemoveConnection_2)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_1)
	Transmission methods.
	UT_DECLARE_SCRIPT_METHOD (SendMessage_2)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_3)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToCommander_1)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToCommander_2)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToPeers)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToSubordinates)
	UT_DECLARE_SCRIPT_METHOD (Xmtr)
	UT_DECLARE_SCRIPT_METHOD (XmtrCount)
	UT_DECLARE_SCRIPT_METHOD (Rcvr)
	UT_DECLARE_SCRIPT_METHOD (RcvrCount)
	UT_DECLARE_SCRIPT_METHOD (CanSendTo)
Public Member Functions inherited from WsfScriptArticulatedPartClass
	WsfScriptArticulatedPartClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
	UT_DECLARE_SCRIPT_METHOD (Pitch)
	UT_DECLARE_SCRIPT_METHOD (SetPitch)
	UT_DECLARE_SCRIPT_METHOD (Roll)
	UT_DECLARE_SCRIPT_METHOD (SetRoll)
	UT_DECLARE_SCRIPT_METHOD (Yaw)
	UT_DECLARE_SCRIPT_METHOD (SetYaw)
	UT_DECLARE_SCRIPT_METHOD (X)
	UT_DECLARE_SCRIPT_METHOD (Y)
	UT_DECLARE_SCRIPT_METHOD (Z)
	UT_DECLARE_SCRIPT_METHOD (DX)
	UT_DECLARE_SCRIPT_METHOD (DY)
	UT_DECLARE_SCRIPT_METHOD (DZ)
	UT_DECLARE_SCRIPT_METHOD (SetXYZ)
	UT_DECLARE_SCRIPT_METHOD (SetDXYZ)
	UT_DECLARE_SCRIPT_METHOD (Location)
	UT_DECLARE_SCRIPT_METHOD (CanSlewInAzimuth)
	UT_DECLARE_SCRIPT_METHOD (CanSlewInElevation)
	UT_DECLARE_SCRIPT_METHOD (SlewMinimumAzimuth)
	UT_DECLARE_SCRIPT_METHOD (SlewMaximumAzimuth)
	UT_DECLARE_SCRIPT_METHOD (SlewMinimumElevation)
	UT_DECLARE_SCRIPT_METHOD (SlewMaximumElevation)
	UT_DECLARE_SCRIPT_METHOD (IsSlewing)
	UT_DECLARE_SCRIPT_METHOD (CanCueInAzimuth)
	UT_DECLARE_SCRIPT_METHOD (CanCueInElevation)
	UT_DECLARE_SCRIPT_METHOD (CueMinimumAzimuth)
	UT_DECLARE_SCRIPT_METHOD (CueMaximumAzimuth)
	UT_DECLARE_SCRIPT_METHOD (CueMinimumElevation)
	UT_DECLARE_SCRIPT_METHOD (CueMaximumElevation)
	UT_DECLARE_SCRIPT_METHOD (ActualCuedAzimuth)
	UT_DECLARE_SCRIPT_METHOD (ActualCuedElevation)
	UT_DECLARE_SCRIPT_METHOD (CurrentCuedAzimuth)
	UT_DECLARE_SCRIPT_METHOD (CurrentCuedElevation)
	UT_DECLARE_SCRIPT_METHOD (ApparentLocationOf)
	UT_DECLARE_SCRIPT_METHOD (RelativeAzimuthOf)
	UT_DECLARE_SCRIPT_METHOD (RelativeElevationOf)
	UT_DECLARE_SCRIPT_METHOD (CueToLLA)
	UT_DECLARE_SCRIPT_METHOD (CueToWCS)
	UT_DECLARE_SCRIPT_METHOD (CueToWCS_2)
	UT_DECLARE_SCRIPT_METHOD (CueToPoint)
	UT_DECLARE_SCRIPT_METHOD (CueToTrack)
	UT_DECLARE_SCRIPT_METHOD (CueToAbsoluteAzEl)
	UT_DECLARE_SCRIPT_METHOD (CueToRelativeAzEl)
	UT_DECLARE_SCRIPT_METHOD (ClearCueing)
	UT_DECLARE_SCRIPT_METHOD (IsCued)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToLLA)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToWCS)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToWCS_2)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToPoint)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToTrack)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToAbsoluteAzEl)
	UT_DECLARE_SCRIPT_METHOD (TimeToCueToRelativeAzEl)
	UT_DECLARE_SCRIPT_METHOD (MaskingPatternState)
	UT_DECLARE_SCRIPT_METHOD (SetMaskingPatternState)
	UT_DECLARE_SCRIPT_METHOD (EnableArticulationUpdates)
	UT_DECLARE_SCRIPT_METHOD (DisableArticulationUpdates)
	UT_DECLARE_SCRIPT_METHOD (ConvertPCSVectorToWCS)
	UT_DECLARE_SCRIPT_METHOD (ConvertWCSVectorToPCS)
	UT_DECLARE_SCRIPT_METHOD (ConvertPCSVectorToECS)
	UT_DECLARE_SCRIPT_METHOD (ConvertECSVectorToPCS)
Public Member Functions inherited from WsfScriptPlatformPartClass
	WsfScriptPlatformPartClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
void	OnNewScriptRef (UtScriptRef &aReference) override
	UT_DECLARE_SCRIPT_METHOD (Platform)
	UT_DECLARE_SCRIPT_METHOD (IsNonOperational)
	UT_DECLARE_SCRIPT_METHOD (IsOperational)
	UT_DECLARE_SCRIPT_METHOD (SetOperational)
	UT_DECLARE_SCRIPT_METHOD (IsNonCritical)
	UT_DECLARE_SCRIPT_METHOD (IsCritical)
	UT_DECLARE_SCRIPT_METHOD (SetCritical)
	UT_DECLARE_SCRIPT_METHOD (IsTurnedOff)
	UT_DECLARE_SCRIPT_METHOD (IsTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (InitiallyTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (TimeSinceLastStatusChange)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_1)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_2)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToProcessor)
	UT_DECLARE_SCRIPT_METHOD (SetDebugEnabled)
	UT_DECLARE_SCRIPT_METHOD (DebugEnabled)
	UT_DECLARE_SCRIPT_METHOD (SetDamageFactor)
	UT_DECLARE_SCRIPT_METHOD (DamageFactor)
	UT_DECLARE_SCRIPT_METHOD (CanBeMadeOperational)
	UT_DECLARE_SCRIPT_METHOD (CanBeMadeNonOperational)
	UT_DECLARE_SCRIPT_METHOD (CanBeTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (CanBeTurnedOff)
	UT_DECLARE_SCRIPT_METHOD (CategoryMemberOf)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_1)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_2)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_3)
	UT_DECLARE_SCRIPT_METHOD (GetGroupByIndex)
	UT_DECLARE_SCRIPT_METHOD (GetGroupByName)
	UT_DECLARE_SCRIPT_METHOD (GroupsByName)
	UT_DECLARE_SCRIPT_METHOD (Groups)
	UT_DECLARE_SCRIPT_METHOD (GroupJoin)
	UT_DECLARE_SCRIPT_METHOD (GroupLeave)
Public Member Functions inherited from WsfScriptObjectClass
	WsfScriptObjectClass (const std::string &aClassName, UtScriptTypes *aTypesPtr)
	~WsfScriptObjectClass () override
void *	Create (const UtScriptContext &aInstance) override
void *	Clone (void *aObjectPtr) override
void	Destroy (void *aObjectPtr) override
std::string	ToString (void *aObjectPtr) const override
	UT_DECLARE_SCRIPT_METHOD (Name)
	UT_DECLARE_SCRIPT_METHOD (Type)
	UT_DECLARE_SCRIPT_METHOD (BaseType)
	UT_DECLARE_SCRIPT_METHOD (IsA_TypeOf)
	UT_DECLARE_SCRIPT_METHOD (ProcessInput)

Detailed Description

Define script methods for WsfComm.

Constructor & Destructor Documentation

◆ WsfScriptCommClass()

WsfScriptCommClass::WsfScriptCommClass	(	const std::string &	aClassName,
		UtScriptTypes *	aScriptTypesPtr )

References WsfScriptArticulatedPartClass::WsfScriptArticulatedPartClass().

Referenced by UT_DECLARE_SCRIPT_METHOD().

Member Function Documentation

◆ UT_DECLARE_SCRIPT_METHOD() [1/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( AddConnection_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [2/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( AddConnection_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [3/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( CanSendTo )

◆ UT_DECLARE_SCRIPT_METHOD() [4/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( DisableConnection_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [5/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( DisableConnection_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [6/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( EnableConnection_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [7/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( EnableConnection_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [8/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( GetAddress )

◆ UT_DECLARE_SCRIPT_METHOD() [9/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( GetComm )

Network Manager pass-through.

◆ UT_DECLARE_SCRIPT_METHOD() [10/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( GetMedium )

Medium script API accessor.

◆ UT_DECLARE_SCRIPT_METHOD() [11/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( GetRouter )

◆ UT_DECLARE_SCRIPT_METHOD() [12/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( IsA_TypeOf )

References WsfScriptCommClass().

◆ UT_DECLARE_SCRIPT_METHOD() [13/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( IsConnectedTo_1 )

Connection methods.

◆ UT_DECLARE_SCRIPT_METHOD() [14/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( IsConnectedTo_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [15/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( IsConnectionEnabled_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [16/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( IsConnectionEnabled_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [17/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( NetworkName )

◆ UT_DECLARE_SCRIPT_METHOD() [18/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( PathExistsTo_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [19/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( PathExistsTo_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [20/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( Rcvr )

◆ UT_DECLARE_SCRIPT_METHOD() [21/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( RcvrCount )

◆ UT_DECLARE_SCRIPT_METHOD() [22/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( RemoveConnection_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [23/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( RemoveConnection_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [24/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessage_1 )

Transmission methods.

◆ UT_DECLARE_SCRIPT_METHOD() [25/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessage_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [26/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessage_3 )

◆ UT_DECLARE_SCRIPT_METHOD() [27/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessageToCommander_1 )

◆ UT_DECLARE_SCRIPT_METHOD() [28/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessageToCommander_2 )

◆ UT_DECLARE_SCRIPT_METHOD() [29/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessageToPeers )

◆ UT_DECLARE_SCRIPT_METHOD() [30/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( SendMessageToSubordinates )

◆ UT_DECLARE_SCRIPT_METHOD() [31/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( TurnOff )

◆ UT_DECLARE_SCRIPT_METHOD() [32/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( TurnOn )

◆ UT_DECLARE_SCRIPT_METHOD() [33/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( Xmtr )

◆ UT_DECLARE_SCRIPT_METHOD() [34/34]

WsfScriptCommClass::UT_DECLARE_SCRIPT_METHOD ( XmtrCount )

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

Public Member Functions