 |
MAK RTIspy API Documentation for HLA 1.3
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK RTIspy API Documentation for HLA 1.3
|
Go to the source code of this file.
Classes | |
| struct | DtRtiAssistantCommand |
| class | DtDeepCopyPointerVector< T > |
| Deep copy a vector pointer entry into the provided target vector This helper functor is used in for_each to deep copy a vector of pointers for_each(orig.begin(), orig.end(), DtDeepCopyPointerVector<T>(target));. More... | |
| class | DtDeepCopyPointerSet< T > |
| Deep copy a set pointer entry into the provided target set This helper functor is used in for_each to deep copy a set of pointers for_each(orig.begin(), orig.end(), DtDeepCopyPointerSet<T>(target));. More... | |
| class | DtDeepCopyByPointerMap< T, Y > |
| Deep copy a map pointer entry into the provided target map. More... | |
| class | DtDeepCopyToPointerMap< T, Y > |
| Deep copy a map of pointer entries into the provided target map. More... | |
| class | DtSourceKeyToTargetKeyLinkReconstructor< TargetKeyType, SourceKeyType, T > |
Namespaces | |
| MAKRti | |
| DtIFSPEC13. | |
Macros | |
| #define | MAKRTI_MT |
| #define | MAK_STATIC |
| #define | DtRtiFatal DtRtiOutputStream( MAKRti::DtNlFatal ) |
| The following macros are intended for use by plugins or applications which link to the RTI to facilitate logging messages from them to the RTI log file or console. More... | |
| #define | DtRtiWarn DtRtiOutputStream( MAKRti::DtNlWarn ) |
| #define | DtRtiInfo DtRtiOutputStream( MAKRti::DtNlInfo ) |
| #define | DtRtiVerbose DtRtiOutputStream( MAKRti::DtNlVerbose ) |
| #define | DtRtiDebug DtRtiOutputStream( MAKRti::DtNlDebug ) |
| #define | DtIsMember(container, element) (container.find(element) != container.end()) |
| Return true if the element is a member of the container. More... | |
| #define | DtTHROW_PROPAGATE(exceptionClass, errorMsg, exPtr) throw exceptionClass(MAKRti::DtString(#exceptionClass": ") + errorMsg, __DtFUNC__, MAKRti::DtFilename::stripPath(__FILE__), __LINE__, exPtr) |
| Throws a propgated MAKRti::DtException using the class name and the error message. More... | |
Typedefs | |
| typedef std::pair < MAKRti::DtInetAddr, int > | DtInetAddrAndPort |
| typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorDefault > | DtRtiException |
| typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorPopup > | DtRtiExceptionPopup |
| typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorInvalidRidExpression > | DtRtiExceptionInvalidRidExpression |
Functions | |
| DT_DLL_RTIUTIL void | DtRtiAttachNotificationPrinter (MAKRti::DtNotifyLevelType level, MAKRti::DtPrinter *printer) |
| Windows only: Attach a MAKRti::DtPrinter to the RTI .dll's internal notification stream, since they are not exported. More... | |
| DT_DLL_RTIUTIL void | DtRtiDetachNotificationPrinter (MAKRti::DtNotifyLevelType level, MAKRti::DtPrinter *printer) |
| Windows only: Detach a MAKRti::DtPrinter from the RTI .dll's internal notification stream, since they are not exported. More... | |
| DT_DLL_RTIUTIL MAKRti::DtFilename | DtRtiSearchPathList (const MAKRti::DtFilename &libName, const MAKRti::DtString &searchPath="") |
| Search the system path for the specified library by name, and return the path to it If searchPath isn't specified, function will use PATH & LD_LIBRARY_PATH as appropriate. More... | |
| DT_DLL_RTIUTIL MAKRti::DtFilename | DtRtiLibPath (const MAKRti::DtString &searchPath="") |
| Search the system path for the RTI library and return the path to it If searchPath isn't specified, function will use PATH & LD_LIBRARY_PATH as appropriate. More... | |
| DT_DLL_RTIUTIL MAKRti::DtString & | DtMakeFileNameUnique (MAKRti::DtString &fileName) |
| Given the filepath, append unique characters to base file name to make it unique Returns the submitted string modified to be unique. More... | |
| DT_DLL_RTIUTIL MAKRti::DtFilename & | DtResolveAbsoluteFileLocation (const MAKRti::DtString &path, const MAKRti::DtString &fileName, MAKRti::DtFilename &resolvedFilePath) |
| Returns the absolute file location Returns the constructed file name in the file name given as a parameter. More... | |
| DT_DLL_RTIUTIL MAKRti::DtFilename & | DtMakeLogFilePath (const MAKRti::DtString &baseFilePath, const MAKRti::DtString &fileName, bool makeUnique, MAKRti::DtFilename &resolvedFilePath) |
| Makes a log file name from the given path and file name. More... | |
| DT_DLL_RTIUTIL MAKRti::DtString | DtGetProcessName () |
| Return the process name of the current process. More... | |
| DT_DLL_RTIUTIL bool | DtLocateConfigFile (MAKRti::DtFilename const &fileName, MAKRti::DtFilename &locatedFileName) |
| Locate a configuration file in the following order. More... | |
| DT_DLL_RTIUTIL bool | DtNonBlockingPollInputLine (MAKRti::DtString &buffer) |
| Polls line-buffered standard input without blocking execution. More... | |
| DT_DLL_RTIUTIL int | DtGetKey () |
| Returns a single character of input from stdin. More... | |
| DT_DLL_RTIUTIL int | DtKBHit () |
| Detect if there has been a button press on stdin. More... | |
| DT_DLL_RTIUTIL void | DtSetNotifyLevel (unsigned int notifyLevel) |
| DT_DLL_RTIUTIL bool | DtReadFile (FILE *fileHandle, char **fileBuffer, unsigned int *fileSize) |
| Read an opened file into a new buffer of returned size. More... | |
| DT_DLL_RTIUTIL int | DtBitsRequiredToRepresent (unsigned long x) |
| Return the number of bits required to represent the given value as an unsigned integer. More... | |
| DT_DLL_RTIUTIL const MAKRti::DtString & | DtGetLocalHostName () |
| Returns the local hostname. Not threadsafe. More... | |
| DT_DLL_RTIUTIL void | DtGetLocalHostName (MAKRti::DtString &hostName, bool onlyFillIfEmpty=true) |
| Sets the given string to the local hostname. More... | |
| DT_DLL_RTIUTIL MAKRti::DtString | DtPerformDNSLookup (MAKRti::DtInetAddr addr) |
| Could be costly operation. More... | |
| DT_DLL_RTIUTIL MAKRti::DtException const & | DtInitialException (MAKRti::DtException const &ex) |
| Return the initial exception if exceptions were chained or this one if not. More... | |
| DT_DLL_RTIUTIL MAKRti::DtOutputStream & | DtRtiOutputStream (MAKRti::DtNotifyLevelType level) |
| Return a reference to the RTI's MAKRti::DtOutputStream objects so plugins and applications can log to the RTI logfile. More... | |
| DT_DLL_RTIUTIL MAKRti::DtString | addrAndPortToString (const DtInetAddrAndPort &addrPort) |
| DT_DLL_RTIUTIL void | shutdownAssistant (bool force) |
| DT_DLL_RTIUTIL void | startupAssistant () |
| DT_DLL_RTIUTIL bool | changeAssistantStartup (DtRtiAssistantStartupRequest desiredState) |
| DT_DLL_RTIUTIL bool | removeAssistantStartup () |
| DT_DLL_RTIUTIL void | queryAssistantStartup (bool &isStartupItem, bool &isUserStartupItem) |
| template<class T > | |
| void | DtDeletePointerContainer (T &pointerContainer) |
| Delete elements of a unary container (e.g. vector or set) of pointers. More... | |
| template<class T > | |
| void | DtDeleteByPointerMap (T &byPointerMap) |
| Delete key elements of a map by pointers. More... | |
| template<class T > | |
| void | DtDeleteToPointerMap (T &pointerMap) |
| Delete value elements of a map to pointers. More... | |
| template<class T , class Thandle > | |
| void | DtAdjustHandles (T *info, std::map< Thandle, T * > &byHandle, std::map< MAKRti::DtString, T * > &byName) |
| The given info has been inserted at end of byHandle map (with highest handle value). More... | |
| template<class T , class Thandle > | |
| void | DtAdjustOwnHandles (T *info, std::map< Thandle, T * > &byHandle, std::map< Thandle, T * > &ownByHandle, std::map< MAKRti::DtString, T * > &byName) |
| The given info has been inserted at end of byHandle map (with highest handle value). More... | |
| template<typename T , typename TContainer > | |
| bool | DtUNIQUE_INSERT (const T &value, TContainer &container) |
| Insert a copy of a value into a container IF that value is not already in the container If the value exists, the container is unmodified and the function returns false. More... | |
| DT_DLL_RTIUTIL MAKRti::DtInetAddr | DtDefaultInterfaceAddr () |
| Get's the address of the default network interface on this machine. More... | |
| DT_DLL_RTIUTIL int | DtEnumerateInterfaces (std::vector< MAKRti::DtInetAddr > &addresses, bool ignoreLoopback) |
| Populate addresses with the IPs of local NICs. More... | |
| DT_DLL_RTIUTIL bool | DtIsIpOfLocalInterface (const MAKRti::DtInetAddr &addrInQuestion, bool refresh=false) |
| returns true for isAnyAddr, and if DtInetaddr matches ip of a local interface. More... | |
| DT_DLL_RTIUTIL unsigned long long | DtFirstHostMACAddr () |
| DT_DLL_RTIUTIL MAKRti::DtString | timeString (const MAKRti::DtClock &clock) |
| Return a string representing elapsed time and absolute time in seconds from clock wall clock time from system. More... | |
| DT_DLL_RTIUTIL MAKRti::DtString | timeString () |
| Return a string representing wall clock time from system. More... | |
| DT_DLL_RTIUTIL void | writeMessageToStdErrPipe (const MAKRti::DtString &msg) |
| Write the given message to a stdErr pipe. More... | |
Variables | |
| DT_DLL_RTIUTIL typedef std::set< MAKRti::DtInetAddr > | DtInetAddrSet |
| const unsigned int | DtGreatestValidPortNumber = 65535 |
| #define DtIsMember | ( | container, | |
| element | |||
| ) | (container.find(element) != container.end()) |
Return true if the element is a member of the container.
| #define DtRtiDebug DtRtiOutputStream( MAKRti::DtNlDebug ) |
| #define DtRtiFatal DtRtiOutputStream( MAKRti::DtNlFatal ) |
The following macros are intended for use by plugins or applications which link to the RTI to facilitate logging messages from them to the RTI log file or console.
| #define DtRtiInfo DtRtiOutputStream( MAKRti::DtNlInfo ) |
| #define DtRtiVerbose DtRtiOutputStream( MAKRti::DtNlVerbose ) |
| #define DtRtiWarn DtRtiOutputStream( MAKRti::DtNlWarn ) |
| #define DtTHROW_PROPAGATE | ( | exceptionClass, | |
| errorMsg, | |||
| exPtr | |||
| ) | throw exceptionClass(MAKRti::DtString(#exceptionClass": ") + errorMsg, __DtFUNC__, MAKRti::DtFilename::stripPath(__FILE__), __LINE__, exPtr) |
Throws a propgated MAKRti::DtException using the class name and the error message.
| #define MAK_STATIC |
| #define MAKRTI_MT |
| typedef std::pair< MAKRti::DtInetAddr, int > DtInetAddrAndPort |
| typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorDefault> DtRtiException |
| typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorInvalidRidExpression> DtRtiExceptionInvalidRidExpression |
| typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorPopup> DtRtiExceptionPopup |
| DT_DLL_RTIUTIL MAKRti::DtString addrAndPortToString | ( | const DtInetAddrAndPort & | addrPort | ) |
| DT_DLL_RTIUTIL bool changeAssistantStartup | ( | DtRtiAssistantStartupRequest | desiredState | ) |
| void DtAdjustHandles | ( | T * | info, |
| std::map< Thandle, T * > & | byHandle, | ||
| std::map< MAKRti::DtString, T * > & | byName | ||
| ) |
The given info has been inserted at end of byHandle map (with highest handle value).
Swap its handle with the info immediately behind it in the byName map, adjusting handles in between.
| void DtAdjustOwnHandles | ( | T * | info, |
| std::map< Thandle, T * > & | byHandle, | ||
| std::map< Thandle, T * > & | ownByHandle, | ||
| std::map< MAKRti::DtString, T * > & | byName | ||
| ) |
The given info has been inserted at end of byHandle map (with highest handle value).
Swap its handle with the info immediately behind it in the byName map, adjusting handles in between.
| DT_DLL_RTIUTIL int DtBitsRequiredToRepresent | ( | unsigned long | x | ) |
Return the number of bits required to represent the given value as an unsigned integer.
(1 bit if x is 0)
| DT_DLL_RTIUTIL MAKRti::DtInetAddr DtDefaultInterfaceAddr | ( | ) |
Get's the address of the default network interface on this machine.
| void DtDeleteByPointerMap | ( | T & | byPointerMap | ) |
Delete key elements of a map by pointers.
Referenced by DtDeepCopyByPointerMap< T, Y >::DtDeepCopyByPointerMap().
| void DtDeletePointerContainer | ( | T & | pointerContainer | ) |
Delete elements of a unary container (e.g. vector or set) of pointers.
Referenced by DtDeepCopyPointerSet< T >::DtDeepCopyPointerSet(), and DtDeepCopyPointerVector< T >::DtDeepCopyPointerVector().
| void DtDeleteToPointerMap | ( | T & | pointerMap | ) |
Delete value elements of a map to pointers.
Referenced by DtDeepCopyToPointerMap< T, Y >::DtDeepCopyToPointerMap().
| DT_DLL_RTIUTIL int DtEnumerateInterfaces | ( | std::vector< MAKRti::DtInetAddr > & | addresses, |
| bool | ignoreLoopback | ||
| ) |
Populate addresses with the IPs of local NICs.
Zero indicates success. Windows and Linux ONLY.
| DT_DLL_RTIUTIL unsigned long long DtFirstHostMACAddr | ( | ) |
| DT_DLL_RTIUTIL int DtGetKey | ( | ) |
Returns a single character of input from stdin.
Blocking, usually guarded with a call to kbhit()
| DT_DLL_RTIUTIL const MAKRti::DtString& DtGetLocalHostName | ( | ) |
Returns the local hostname. Not threadsafe.
| DT_DLL_RTIUTIL void DtGetLocalHostName | ( | MAKRti::DtString & | hostName, |
| bool | onlyFillIfEmpty = true |
||
| ) |
Sets the given string to the local hostname.
If the string already has text, leave it as is
| DT_DLL_RTIUTIL MAKRti::DtString DtGetProcessName | ( | ) |
Return the process name of the current process.
| DT_DLL_RTIUTIL MAKRti::DtException const& DtInitialException | ( | MAKRti::DtException const & | ex | ) |
Return the initial exception if exceptions were chained or this one if not.
| DT_DLL_RTIUTIL bool DtIsIpOfLocalInterface | ( | const MAKRti::DtInetAddr & | addrInQuestion, |
| bool | refresh = false |
||
| ) |
returns true for isAnyAddr, and if DtInetaddr matches ip of a local interface.
If refresh is true, function will refresh the hardware list (costly)
| DT_DLL_RTIUTIL int DtKBHit | ( | ) |
Detect if there has been a button press on stdin.
Doesn't shift input.
| DT_DLL_RTIUTIL bool DtLocateConfigFile | ( | MAKRti::DtFilename const & | fileName, |
| MAKRti::DtFilename & | locatedFileName | ||
| ) |
Locate a configuration file in the following order.
A) if file name is empty, return false B) if file name is an absolute path if file exists, return true otherwise return false C) if file name is a relative path if file exists relative to CWD, return true. else if file exists relative to RTI_CONFIG env. variable return true otherwise return false Returns bool: file was located? The located file name is returned via the second parameter including prepended path if located in RTI_CONFIG
| DT_DLL_RTIUTIL MAKRti::DtString& DtMakeFileNameUnique | ( | MAKRti::DtString & | fileName | ) |
Given the filepath, append unique characters to base file name to make it unique Returns the submitted string modified to be unique.
| DT_DLL_RTIUTIL MAKRti::DtFilename& DtMakeLogFilePath | ( | const MAKRti::DtString & | baseFilePath, |
| const MAKRti::DtString & | fileName, | ||
| bool | makeUnique, | ||
| MAKRti::DtFilename & | resolvedFilePath | ||
| ) |
Makes a log file name from the given path and file name.
Makes it unique if indicated. Returns the constructed file name in the file name given as a parameter.
| DT_DLL_RTIUTIL bool DtNonBlockingPollInputLine | ( | MAKRti::DtString & | buffer | ) |
Polls line-buffered standard input without blocking execution.
Input is stored in supplied buffer. Returns true when carriage return received as input (not added to buffer) at which point the buffer should be consumed (or copied) and emptied for subsequent calls. Returns false otherwise.
| DT_DLL_RTIUTIL MAKRti::DtString DtPerformDNSLookup | ( | MAKRti::DtInetAddr | addr | ) |
Could be costly operation.
Performs DNS lookup on input MAKRti::DtInetAddr. MAKRti::DtString is empty on failure. Doesn't correctly resolve IPv6 addresses yet.
| DT_DLL_RTIUTIL bool DtReadFile | ( | FILE * | fileHandle, |
| char ** | fileBuffer, | ||
| unsigned int * | fileSize | ||
| ) |
Read an opened file into a new buffer of returned size.
| DT_DLL_RTIUTIL MAKRti::DtFilename& DtResolveAbsoluteFileLocation | ( | const MAKRti::DtString & | path, |
| const MAKRti::DtString & | fileName, | ||
| MAKRti::DtFilename & | resolvedFilePath | ||
| ) |
Returns the absolute file location Returns the constructed file name in the file name given as a parameter.
| DT_DLL_RTIUTIL void DtRtiAttachNotificationPrinter | ( | MAKRti::DtNotifyLevelType | level, |
| MAKRti::DtPrinter * | printer | ||
| ) |
Windows only: Attach a MAKRti::DtPrinter to the RTI .dll's internal notification stream, since they are not exported.
| DT_DLL_RTIUTIL void DtRtiDetachNotificationPrinter | ( | MAKRti::DtNotifyLevelType | level, |
| MAKRti::DtPrinter * | printer | ||
| ) |
Windows only: Detach a MAKRti::DtPrinter from the RTI .dll's internal notification stream, since they are not exported.
| DT_DLL_RTIUTIL MAKRti::DtFilename DtRtiLibPath | ( | const MAKRti::DtString & | searchPath = "" | ) |
Search the system path for the RTI library and return the path to it If searchPath isn't specified, function will use PATH & LD_LIBRARY_PATH as appropriate.
| DT_DLL_RTIUTIL MAKRti::DtOutputStream& DtRtiOutputStream | ( | MAKRti::DtNotifyLevelType | level | ) |
Return a reference to the RTI's MAKRti::DtOutputStream objects so plugins and applications can log to the RTI logfile.
| DT_DLL_RTIUTIL MAKRti::DtFilename DtRtiSearchPathList | ( | const MAKRti::DtFilename & | libName, |
| const MAKRti::DtString & | searchPath = "" |
||
| ) |
Search the system path for the specified library by name, and return the path to it If searchPath isn't specified, function will use PATH & LD_LIBRARY_PATH as appropriate.
| DT_DLL_RTIUTIL void DtSetNotifyLevel | ( | unsigned int | notifyLevel | ) |
| bool DtUNIQUE_INSERT | ( | const T & | value, |
| TContainer & | container | ||
| ) |
Insert a copy of a value into a container IF that value is not already in the container If the value exists, the container is unmodified and the function returns false.
Returns true if inserted, false if element already contained.
| DT_DLL_RTIUTIL void queryAssistantStartup | ( | bool & | isStartupItem, |
| bool & | isUserStartupItem | ||
| ) |
| DT_DLL_RTIUTIL bool removeAssistantStartup | ( | ) |
| DT_DLL_RTIUTIL void shutdownAssistant | ( | bool | force | ) |
| DT_DLL_RTIUTIL void startupAssistant | ( | ) |
| DT_DLL_RTIUTIL MAKRti::DtString timeString | ( | const MAKRti::DtClock & | clock | ) |
Return a string representing elapsed time and absolute time in seconds from clock wall clock time from system.
Referenced by DtFederateConnectFilter< ParentClass >::applyFilter(), DtRtiExecConnectionFilter< DtRtiExecHandshakeProcessor >::applyFilter(), DtRtiExecConnectionFilter< ParentType >::doMessageProcessing(), DtFederateTimeStateInfo::operator==(), and DtAssistantFederateInfo::operator==().
| DT_DLL_RTIUTIL MAKRti::DtString timeString | ( | ) |
Return a string representing wall clock time from system.
| DT_DLL_RTIUTIL void writeMessageToStdErrPipe | ( | const MAKRti::DtString & | msg | ) |
Write the given message to a stdErr pipe.
| const unsigned int DtGreatestValidPortNumber = 65535 |
| DT_DLL_RTIUTIL typedef std::set<MAKRti::DtInetAddr> DtInetAddrSet |