MAK RTIspy API Documentation for HLA 1.3
Macros | Functions | Variables
assistantConfig.cxx File Reference

Macros

#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_UINT_PARAMETER (latencyTestInteractionPeriodMs, setLatencyTestInteractionPeriodMs, 100,"latencyTestInteractionPeriod","The period, in ms, between the sending of interactions in a latency test.") DtDEFINE_UINT_PARAMETER(latencyTestNumInteractions
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test 
DtDEFINE_UINT_PARAMETER (latencyTestPayloadBytes, setLatencyTestPayloadBytes, 0,"latencyTestPayloadBytes","The number of bytes in an interaction payload for a latency test.") DtDEFINE_BOOL_PARAMETER(displayPopupsAsNotifications
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications 
DtDEFINE_BOOL_PARAMETER (enableNotifications, setEnableNotifications, true,"enableNotifications","Determines whether notifications are enabled.") DtDEFINE_UINT_PARAMETER(lightweightMemorySec
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
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_UINT_PARAMETER(lrcNetStatsUpdateIntervalSec
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs 
DtDEFINE_FLOAT_PARAMETER (defunctFederateRemovalTimeSec, setDefunctFederateRemovalTimeSec,-1,"defunctFederateRemovalTime","Determines the persistence, in seconds, of defunct federates in the rtiexec viewer.") DtDEFINE_BOOL_PARAMETER(showRtiexecStartupPrompt
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs Determines whether the
user should be shown a prompt
when an rtiexec is started 
DtDEFINE_BOOL_PARAMETER (acceptRemoteCommands, setAcceptRemoteCommands, true,"acceptRemoteCommands","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 
setLatencyTestNumInteractions
Determines whether the
Assistant will be kept alive
after all components
disconnect 
latencyTestNumInteractions
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test 
setDisplayPopupsAsNotifications
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test 
false
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test 
popupsAsNotifications
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications 
setLightweightMemorySec
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications 
lightweightConnectionMemoryPeriod
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the 
persistence
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in 
seconds
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid 
setLrcNetStatsUpdateIntervalSec
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid 
lrcNetStatsUpdateInterval
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the 
interval
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs 
setShowRtiexecStartupPrompt
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs 
showRtiexecStartupPrompt
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs Determines whether the
user should be shown a prompt
when an rtiexec is started 
setAssistantPersistent
Determines whether the
Assistant will be kept alive
after all components
disconnect The number of
interactions to send in a
latency test Determines
whether popups should be
displayed as notifications
Determines the in of valid
connections once they become
invalid Determines the in at
which this assistant requests
NetStats updates from federate
LRCs Determines whether the
user should be shown a prompt
when an rtiexec is started 
assistantPersistent

Macro Definition Documentation

#define DtDEFINE_BOOL_PARAMETER (   accessor,
  mutator,
  defaultVal,
  shortDesc,
  longDesc 
)
Value:
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 
)
Value:
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 
)
Value:
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; \
} \
}

Function Documentation

Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications DtDEFINE_BOOL_PARAMETER ( enableNotifications  ,
setEnableNotifications  ,
true  ,
"enableNotifications"  ,
"Determines whether notifications are enabled."   
)
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs Determines whether the user should be shown a prompt when an rtiexec is started DtDEFINE_BOOL_PARAMETER ( acceptRemoteCommands  ,
setAcceptRemoteCommands  ,
true  ,
"acceptRemoteCommands"  ,
"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 number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs DtDEFINE_FLOAT_PARAMETER ( defunctFederateRemovalTimeSec  ,
setDefunctFederateRemovalTimeSec  ,
1,
"defunctFederateRemovalTime"  ,
"Determines the  persistence,
in  seconds,
of defunct federates in the rtiexec viewer."   
)
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 DtDEFINE_UINT_PARAMETER ( latencyTestInteractionPeriodMs  ,
setLatencyTestInteractionPeriodMs  ,
100  ,
"latencyTestInteractionPeriod"  ,
"The  period,
in  ms,
between the sending of interactions in a latency test."   
)
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test DtDEFINE_UINT_PARAMETER ( latencyTestPayloadBytes  ,
setLatencyTestPayloadBytes  ,
,
"latencyTestPayloadBytes"  ,
"The number of bytes in an interaction payload for a latency test."   
)
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications 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."   
)

Variable Documentation

Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs Determines whether the user should be shown a prompt when an rtiexec is started assistantPersistent
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test false
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the interval
keepAlive
Determines whether the Assistant will be kept alive after all components disconnect latencyTestNumInteractions
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications lightweightConnectionMemoryPeriod
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid lrcNetStatsUpdateInterval
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the persistence
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test popupsAsNotifications
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications 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 number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs Determines whether the user should be shown a prompt when an rtiexec is started setAssistantPersistent
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test setDisplayPopupsAsNotifications
setKeepAlive
Determines whether the Assistant will be kept alive after all components disconnect setLatencyTestNumInteractions
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications setLightweightMemorySec
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid setLrcNetStatsUpdateIntervalSec
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs setShowRtiexecStartupPrompt
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs showRtiexecStartupPrompt
Determines whether the Assistant will be kept alive after all components disconnect The number of interactions to send in a latency test Determines whether popups should be displayed as notifications Determines the in of valid connections once they become invalid Determines the in at which this assistant requests NetStats updates from federate LRCs Determines whether the user should be shown a prompt when an rtiexec is started true

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)