![]() |
MAK RTIspy API Documentation for HLA 1516
|
Defines | |
| #define | DtDEFINE_UINT_PARAMETER(accessor, mutator, defaultVal, shortDesc, longDesc) |
| #define | DtDEFINE_BOOL_PARAMETER(accessor, mutator, defaultVal, shortDesc, longDesc) |
| #define | DtDEFINE_FLOAT_PARAMETER(accessor, mutator, defaultVal, shortDesc, longDesc) |
| #define | DtDEFINE_DEPENDENT_BOOL_PARAMETERS(accessor, mutator, defaultVal, shortDesc, longDesc, depAccessor, depMutator, depDefaultVal, depShortDesc, depLongDesc) |
Functions | |
| DtDEFINE_UINT_PARAMETER (logUpdateInterval, setLogUpdateInterval, 400,"logUpdateInterval","The interval, in msec, at which a log display will be refreshed.") DtDEFINE_BOOL_PARAMETER(keepAlive | |
| Determines whether the Assistant will be kept alive after all components disconnect | DtDEFINE_DEPENDENT_BOOL_PARAMETERS (showViewLogPrompt, setShowViewLogPrompt, true,"showViewLogPrompt","Determines whether the user should be asked if they want to view the log when enabling logging.", alwaysViewLog, setAlwaysViewLog, false,"alwaysViewLog","Determines whether the Assistant will automatically open logs when logging is enabled.") DtDEFINE_UINT_PARAMETER(latencyTestInteractionPeriodMs |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test | DtDEFINE_UINT_PARAMETER (latencyTestNumInteractions, setLatencyTestNumInteractions, 5,"latencyTestNumInteractions","The number of interactions to send in a latency test.") DtDEFINE_UINT_PARAMETER(latencyTestPayloadBytes |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test | DtDEFINE_BOOL_PARAMETER (displayPopupsAsNotifications, setDisplayPopupsAsNotifications, false,"popupsAsNotifications","Determines whether popups should be displayed as notifications.") DtDEFINE_BOOL_PARAMETER(enableNotifications |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled | DtDEFINE_BOOL_PARAMETER (enableLoopbackDevice, setEnableLoopbackDevice, false,"enableLoopbackDevice","Determines whether the RTI Assistant supports the loopback device.") DtDEFINE_UINT_PARAMETER(lightweightMemorySec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid | DtDEFINE_UINT_PARAMETER (assistantUpdateIntervalSec, setAssistantUpdateIntervalSec, 10,"assistantUpdateInterval","Determines the interval, in seconds, at which this assistant requests updates from remote assistants.") DtDEFINE_FLOAT_PARAMETER(defunctFederateRemovalTimeSec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer | DtDEFINE_BOOL_PARAMETER (showRtiexecStartupPrompt, setShowRtiexecStartupPrompt, true,"showRtiexecStartupPrompt","Determines whether the user should be shown a prompt when an rtiexec is started.") DtDEFINE_BOOL_PARAMETER(acceptRemoteCommands |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote | Assistants (e.g.starting an rtiexec).") DtDEFINE_BOOL_PARAMETER(assistantPersistent |
Variables | |
| setKeepAlive | |
| true | |
| keepAlive | |
| Determines whether the Assistant will be kept alive after all components disconnect | setLatencyTestInteractionPeriodMs |
| Determines whether the Assistant will be kept alive after all components disconnect | latencyTestInteractionPeriod |
| Determines whether the Assistant will be kept alive after all components disconnect The | period |
| Determines whether the Assistant will be kept alive after all components disconnect The in | ms |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test | setLatencyTestPayloadBytes |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test | latencyTestPayloadBytes |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test | setEnableNotifications |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test | enableNotifications |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled | setLightweightMemorySec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled | lightweightConnectionMemoryPeriod |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the | persistence |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in | seconds |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid | setDefunctFederateRemovalTimeSec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid | defunctFederateRemovalTime |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer | setAcceptRemoteCommands |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer | acceptRemoteCommands |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote | setAssistantPersistent |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote | assistantPersistent |
| #define DtDEFINE_BOOL_PARAMETER | ( | accessor, | |
| mutator, | |||
| defaultVal, | |||
| shortDesc, | |||
| longDesc | |||
| ) |
bool DtAssistantConfig::accessor() \ { \ if( !my##accessor##Val.get() ) \ { \ my##accessor##Val = getParam( shortDesc ); \ } \ if( my##accessor##Val.get() ) \ { \ return my##accessor##Val->value().toBoolean(); \ } \ mutator( defaultVal ); \ return defaultVal; \ } \ void DtAssistantConfig::mutator( bool val ) \ { \ if( !my##accessor##Val.get() || \ my##accessor##Val->value().toBoolean() != val ) \ { \ my##accessor##Val = setParam( shortDesc, MAKRti::DtString(val), \ longDesc ); \ myUpdatedSinceWrite = true; \ } \ }
| #define DtDEFINE_DEPENDENT_BOOL_PARAMETERS | ( | accessor, | |
| mutator, | |||
| defaultVal, | |||
| shortDesc, | |||
| longDesc, | |||
| depAccessor, | |||
| depMutator, | |||
| depDefaultVal, | |||
| depShortDesc, | |||
| depLongDesc | |||
| ) |
| #define DtDEFINE_FLOAT_PARAMETER | ( | accessor, | |
| mutator, | |||
| defaultVal, | |||
| shortDesc, | |||
| longDesc | |||
| ) |
float DtAssistantConfig::accessor() \ { \ if( !my##accessor##Val.get() ) \ { \ my##accessor##Val = getParam( shortDesc ); \ } \ if( my##accessor##Val.get() ) \ { \ return my##accessor##Val->value().toFloat(); \ } \ mutator( defaultVal ); \ return defaultVal; \ } \ void DtAssistantConfig::mutator( float val ) \ { \ if( !my##accessor##Val.get() || \ my##accessor##Val->value().toFloat() != val ) \ { \ my##accessor##Val = setParam( shortDesc, MAKRti::DtString(val), \ longDesc ); \ myUpdatedSinceWrite = true; \ } \ }
| #define DtDEFINE_UINT_PARAMETER | ( | accessor, | |
| mutator, | |||
| defaultVal, | |||
| shortDesc, | |||
| longDesc | |||
| ) |
unsigned int DtAssistantConfig::accessor() \ { \ if( !my##accessor##Val.get() ) \ { \ my##accessor##Val = getParam( shortDesc ); \ } \ if( my##accessor##Val.get() ) \ { \ return my##accessor##Val->value().toUInt(); \ } \ mutator( defaultVal ); \ return defaultVal; \ } \ void DtAssistantConfig::mutator( unsigned int val ) \ { \ if( !my##accessor##Val.get() || \ my##accessor##Val->value().toUInt() != val ) \ { \ my##accessor##Val = setParam( shortDesc, MAKRti::DtString(val), \ longDesc ); \ myUpdatedSinceWrite = true; \ } \ }
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote Assistants | ( | e.g.starting an | rtiexec | ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test DtDEFINE_BOOL_PARAMETER | ( | displayPopupsAsNotifications | , |
| setDisplayPopupsAsNotifications | , | ||
| false | , | ||
| "popupsAsNotifications" | , | ||
| "Determines whether popups should be displayed as notifications." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled DtDEFINE_BOOL_PARAMETER | ( | enableLoopbackDevice | , |
| setEnableLoopbackDevice | , | ||
| false | , | ||
| "enableLoopbackDevice" | , | ||
| "Determines whether the RTI Assistant supports the loopback device." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer DtDEFINE_BOOL_PARAMETER | ( | showRtiexecStartupPrompt | , |
| setShowRtiexecStartupPrompt | , | ||
| true | , | ||
| "showRtiexecStartupPrompt" | , | ||
| "Determines whether the user should be shown a prompt when an rtiexec is started." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect DtDEFINE_DEPENDENT_BOOL_PARAMETERS | ( | showViewLogPrompt | , |
| setShowViewLogPrompt | , | ||
| true | , | ||
| "showViewLogPrompt" | , | ||
| "Determines whether the user should be asked if they want to view the log when enabling logging." | , | ||
| alwaysViewLog | , | ||
| setAlwaysViewLog | , | ||
| false | , | ||
| "alwaysViewLog" | , | ||
| "Determines whether the Assistant will automatically open logs when logging is enabled." | |||
| ) |
| DtDEFINE_UINT_PARAMETER | ( | logUpdateInterval | , |
| setLogUpdateInterval | , | ||
| 400 | , | ||
| "logUpdateInterval" | , | ||
| "The | interval, | ||
| in | msec, | ||
| at which a log display will be refreshed." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test DtDEFINE_UINT_PARAMETER | ( | latencyTestNumInteractions | , |
| setLatencyTestNumInteractions | , | ||
| 5 | , | ||
| "latencyTestNumInteractions" | , | ||
| "The number of interactions to send in a latency test." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid DtDEFINE_UINT_PARAMETER | ( | assistantUpdateIntervalSec | , |
| setAssistantUpdateIntervalSec | , | ||
| 10 | , | ||
| "assistantUpdateInterval" | , | ||
| "Determines the | interval, | ||
| in | seconds, | ||
| at which this assistant requests updates from remote assistants." | |||
| ) |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer acceptRemoteCommands |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote assistantPersistent |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid defunctFederateRemovalTime |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test enableNotifications |
| Determines whether the Assistant will be kept alive after all components disconnect latencyTestInteractionPeriod |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test latencyTestPayloadBytes |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled lightweightConnectionMemoryPeriod |
| Determines whether the Assistant will be kept alive after all components disconnect The in ms |
| Determines whether the Assistant will be kept alive after all components disconnect The period |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the persistence |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in seconds |
Referenced by analogClock::setTime().
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer setAcceptRemoteCommands |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote setAssistantPersistent |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid setDefunctFederateRemovalTimeSec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test setEnableNotifications |
| Determines whether the Assistant will be kept alive after all components disconnect setLatencyTestInteractionPeriodMs |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test setLatencyTestPayloadBytes |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled setLightweightMemorySec |
| Determines whether the Assistant will be kept alive after all components disconnect The in between the sending of interactions in a latency test The number of bytes in an interaction payload for a latency test Determines whether notifications are enabled Determines the in of valid connections once they become invalid Determines the in of defunct federates in the rtiexec viewer Determines whether the RTI Assistant accepts commands from remote true |
Referenced by DtRidChooser::checkAssistantShutdownThread(), DtFederateTree::clearCurrDefunctFederates(), DtRtiExecWebManager::issueStateRequest(), DtFedExec::processJoinMsg(), DtFedExec::processReserveMultiName(), DtAssistantFederationsInfoMgr::processSignalTickedMsg(), DtObjectMgr::processSub(), DtAssistantFederationsViewMgr::sendNetworkTestingEnableMsg(), DtAssistantNetworkCompViewMgr::tick(), and DtFilteredTcpForwarder::updateQueuedSockets().