Requests that an application begin sending state information for a specified platform part. More...
#include <WsfXIO_SimPacketRegistry.hpp>
Public Member Functions | |
| XIO_DEFINE_PACKET (WsfXIO_ScriptExecutePkt, WsfXIO_Packet, 61) | |
| void | ReceiveCleanup () override |
| Public Member Functions inherited from WsfXIO_Packet | |
| WsfXIO_Packet (int aPacketId) | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| Serializes the packet header. Must be called first from derived class Serialize(). | |
| float | GetTimeStamp () const |
| void | SetTimeStamp (float aTimeStamp) |
| void | SetFlags (uint32_t aFlags) |
| void | AddFlags (uint32_t aFlags) |
| uint32_t | GetFlags () const |
Public Attributes | |
| bool | mIsApplicationMethod |
| int32_t | mPlatformIndex |
| Index of the platform where the script resides. | |
| WsfStringId | mPartName |
| Name of part if addressing a script on a platform part. | |
| int32_t | mPartType |
| Type of platform part. Only used if mPartName is non-null. | |
| WsfStringId | mScriptName |
| Name of the script to execute. | |
| std::vector< UtScriptData > | mArgumentList |
| List of arguments. | |
| UtScriptData * | mBaseObject |
| For non-static application methods. | |
| std::string | mScriptText |
| For executing a new script function. When using this form, mScriptName should be empty. | |
| Public Attributes inherited from WsfXIO_Packet | |
| GenUniqueId | mApplicationId |
Additional Inherited Members | |
| Public Types inherited from WsfXIO_Packet | |
| enum | PacketFlags { cSYNCHRONIZED = 1 } |
| typedef bool | BaseType |
| Static Public Attributes inherited from WsfXIO_Packet | |
| static const int | cPACKET_ID = -1 |
| Protected Attributes inherited from WsfXIO_Packet | |
| uint32_t | mFlags |
| float | mTimeStamp |
Detailed Description
Requests that an application begin sending state information for a specified platform part.
Member Function Documentation
◆ ReceiveCleanup()
|
inlineoverride |
References mBaseObject.
◆ XIO_DEFINE_PACKET()
|
inline |
References mArgumentList, mBaseObject, mIsApplicationMethod, mPartName, mPartType, mPlatformIndex, mScriptName, mScriptText, and WsfXIO_Packet::WsfXIO_Packet().
Member Data Documentation
◆ mArgumentList
| std::vector<UtScriptData> WsfXIO_ScriptExecutePkt::mArgumentList |
List of arguments.
Referenced by WsfXIO_ScriptService::HandleExecute(), UT_DEFINE_SCRIPT_METHOD(), and XIO_DEFINE_PACKET().
◆ mBaseObject
| UtScriptData* WsfXIO_ScriptExecutePkt::mBaseObject |
For non-static application methods.
Referenced by WsfXIO_ScriptService::HandleExecute(), ReceiveCleanup(), UT_DEFINE_SCRIPT_METHOD(), and XIO_DEFINE_PACKET().
◆ mIsApplicationMethod
| bool WsfXIO_ScriptExecutePkt::mIsApplicationMethod |
Referenced by WsfXIO_ScriptService::HandleExecute(), UT_DEFINE_SCRIPT_METHOD(), and XIO_DEFINE_PACKET().
◆ mPartName
| WsfStringId WsfXIO_ScriptExecutePkt::mPartName |
Name of part if addressing a script on a platform part.
Referenced by WsfXIO_ScriptService::HandleExecute(), and XIO_DEFINE_PACKET().
◆ mPartType
| int32_t WsfXIO_ScriptExecutePkt::mPartType |
Type of platform part. Only used if mPartName is non-null.
Referenced by XIO_DEFINE_PACKET().
◆ mPlatformIndex
| int32_t WsfXIO_ScriptExecutePkt::mPlatformIndex |
Index of the platform where the script resides.
Referenced by WsfXIO_ScriptService::HandleExecute(), UT_DEFINE_SCRIPT_METHOD(), and XIO_DEFINE_PACKET().
◆ mScriptName
| WsfStringId WsfXIO_ScriptExecutePkt::mScriptName |
Name of the script to execute.
Referenced by WsfXIO_ScriptService::HandleExecute(), UT_DEFINE_SCRIPT_METHOD(), and XIO_DEFINE_PACKET().
◆ mScriptText
| std::string WsfXIO_ScriptExecutePkt::mScriptText |
For executing a new script function. When using this form, mScriptName should be empty.
Referenced by WsfXIO_ScriptService::HandleExecute(), and XIO_DEFINE_PACKET().
The documentation for this class was generated from the following file: