Classes
struct	DtRtiAssistantCommand
class	DtDeepCopyPointerIntoVector< 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(), DtDeepCopyPointerIntoVector<T>(target));. More...
class	DtDeepCopyPointerIntoSet< 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(), DtDeepCopyPointerIntoSet<T>(target));. More...
class	DtDeepCopyPointerIntoMap< T, Y >
	Deep copy a map pointer entry into the provided target map This helper functor is used in for_each to deep copy a map of types for_each(orig.begin(), orig.end(), DtDeepCopyPointerIntoMap<T, Y>(target)); NOTE: only the T class is dynamically allocated, the Y class is assumed to be. More...

Macros
#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	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.
#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.

Typedefs
typedef std::pair < MAKRti::DtInetAddr, int >	DtInetAddrAndPort
typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorDefault >	DtRtiException
typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorPopup >	DtRtiExceptionPopup
typedef MAKRti::DtTemplatedException < DtRtiExceptionDesignatorInvalidRidExpression >	DtRtiExceptionInvalidRidExpression

Enumerations
enum	DtRtiAssistantCommandEnum { DtAssistantCommandList, DtAssistantCommandListRtiExec, DtAssistantCommandListForwarder, DtAssistantCommandKill, DtAssistantCommandDeleteFederate }
enum	DtRtiAssistantStartupRequest { DtAssistantStartupNoChange, DtAssistantStartupInstallUser, DtAssistantStartupInstallSys, DtAssistantStartupUninstall }
enum	DtRtiExceptionDesignator { DtRtiExceptionDesignatorDefault, DtRtiExceptionDesignatorPopup, DtRtiExceptionDesignatorInvalidRidExpression }

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.
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	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 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 bool	DtLocateConfigFile (MAKRti::DtFilename const &fileName, MAKRti::DtFilename &locatedFileName)
	Locate a configuration file in the following order.
DT_DLL_RTIUTIL bool	DtNonBlockingPollInputLine (MAKRti::DtString &buffer)
	Polls line-buffered standard input without blocking execution.
DT_DLL_RTIUTIL int	DtGetKey ()
	Returns a single character of input from stdin.
DT_DLL_RTIUTIL int	DtKBHit ()
	Detect if there has been a button press on stdin.
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.
int	DtBitsRequiredToRepresent (unsigned long x)
	Return the number of bits required to represent the given value as an unsigned integer.
DT_DLL_RTIUTIL const MAKRti::DtString &	DtGetLocalHostName ()
	Returns the local hostname.
DT_DLL_RTIUTIL MAKRti::DtString	DtPerformDNSLookup (MAKRti::DtInetAddr addr)
	Could be costly operation.
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 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 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	DtDeleteVectorOfPointers (T &pointerVector)
	Delete elements of a vector of pointers.
template<class T >
void	DtDeleteSetOfPointers (T &pointerSet)
	Delete elements of a set of pointers.
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.
DT_DLL_RTIUTIL MAKRti::DtInetAddr	DtDefaultInterfaceAddr ()
	Get's the address of the default network interface on this machine.
DT_DLL_RTIUTIL int	DtEnumerateInterfaces (std::vector< MAKRti::DtInetAddr > &addresses, bool ignoreLoopback)
	Populate addresses with the IPs of local NICs.
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.
DT_DLL_RTIUTIL unsigned long long	DtFirstHostMACAddr ()

Variables
const unsigned int	DtGreatestValidPortNumber = 65535

Detailed Description

Macro Definition Documentation

#define DtIsMember	(	container,
		element
	)	(container.find(element) != container.end())

Return true if the element is a member of the container.

Referenced by DtFixedGridConfiguration::parseSubspacePartitions().

#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.

Referenced by DtRtiExec::DtRtiExec(), and vrlmod::DtThreadedObject::start().

Typedef Documentation

typedef std::pair< MAKRti::DtInetAddr, int > DtInetAddrAndPort

typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorDefault> DtRtiException

typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorInvalidRidExpression> DtRtiExceptionInvalidRidExpression

typedef MAKRti::DtTemplatedException<DtRtiExceptionDesignatorPopup> DtRtiExceptionPopup

Enumeration Type Documentation

enum DtRtiAssistantCommandEnum

Enumerator:

DtAssistantCommandList
DtAssistantCommandListRtiExec
DtAssistantCommandListForwarder
DtAssistantCommandKill
DtAssistantCommandDeleteFederate

enum DtRtiAssistantStartupRequest

Enumerator:

DtAssistantStartupNoChange
DtAssistantStartupInstallUser
DtAssistantStartupInstallSys
DtAssistantStartupUninstall

enum DtRtiExceptionDesignator

Enumerator:

DtRtiExceptionDesignatorDefault
DtRtiExceptionDesignatorPopup
DtRtiExceptionDesignatorInvalidRidExpression

Function Documentation

DT_DLL_RTIUTIL bool changeAssistantStartup ( DtRtiAssistantStartupRequest desiredState )

References DtAssistantStartupInstallSys, DtAssistantStartupInstallUser, DtAssistantStartupNoChange, DtAssistantStartupUninstall, DtRtiLibPath(), and removeAssistantStartup().

Referenced by DtAssistantPreferencesInfoMgr::DtAssistantPreferencesInfoMgr(), DtAssistantPreferencesViewMgr::processConfigAccept(), and DtAssistantPreferencesInfoMgr::~DtAssistantPreferencesInfoMgr().

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)

Referenced by DtRIDParameters::sanityCheckRIDParameters().

DT_DLL_RTIUTIL MAKRti::DtInetAddr DtDefaultInterfaceAddr ( )

Get's the address of the default network interface on this machine.

Referenced by DtRtiConnectionInfo::defaultNetworkInterfaceAddr(), DtRtiConnectionInfo::defaultReliableIp(), DtAddForwarderFunction(), DtAssistantConnQueryMgr::DtAssistantConnQueryMgr(), DtInOutForwarderPort::DtInOutForwarderPort(), DtJoinLightWeightMsg::DtJoinLightWeightMsg(), DtJoinMsg::DtJoinMsg(), DtMulitcastDiscoveryMgr::DtMulitcastDiscoveryMgr(), DtRtiExec::enableWebSpy(), DtRtiMsgForwarder::init(), DtRIDParameters::initializeForwarderGroups(), DtUdpMsgSocket::recv(), DtRtiexecObserverForAssistant::sendConnectionInfo(), DtJoinLightWeightMsg::set(), DtConnectionCache::setConnFromEnv(), and DtRtiAssistantLrcClient::updateConnInfo().

template<class T >

void DtDeleteSetOfPointers ( T & pointerSet )

Delete elements of a set of pointers.

Referenced by DtDeepCopyPointerIntoSet< T >::DtDeepCopyPointerIntoSet().

template<class T >

void DtDeleteVectorOfPointers ( T & pointerVector )

Delete elements of a vector of pointers.

Referenced by DtDeepCopyPointerIntoVector< T >::DtDeepCopyPointerIntoVector(), and DtFomClassMgr::~DtFomClassMgr().

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 ( )

Referenced by DtForwarderNodeInfo::DtForwarderNodeInfo(), DtInOutForwarderPort::processMacAddrMsg(), and DtInOutForwarderPort::sendMacAddrMsg().

DT_DLL_RTIUTIL int DtGetKey ( )

Returns a single character of input from stdin.

Blocking, usually guarded with a call to kbhit()

Referenced by DtNonBlockingPollInputLine().

DT_DLL_RTIUTIL const MAKRti::DtString& DtGetLocalHostName ( )

Returns the local hostname.

Referenced by DtAssistantLrcConnQueryWidget::checkForValidAddrAndHost(), DtRtiConnectionInfo::defaultHostName(), DtAssistantConnQueryMgr::DtAssistantConnQueryMgr(), DtAssistantFomViewMgr::DtAssistantFomViewMgr(), DtForwarderNodeInfoProcessor::DtForwarderNodeInfoProcessor(), DtInOutForwarderPort::DtInOutForwarderPort(), DtConnectionCache::getLightweightConnectionsFromEnv(), DtConnectionCache::getRtiexecConnectionsFromEnv(), DtRtiAssistant::initializeAssistantServer(), DtRtiMsgForwarder::populateConnectionInformation(), DtAssistantFederationsInfoMgr::processLocalFederateJoined(), DtAssistantConnectionInfoMgr::processLocalRtiComponentConnected(), DtAssistantConnectionInfoMgr::processStartRtiexecMsg(), DtAssistantRtiexecConnQueryWidget::promptUserForConnInfo(), DtAssistantLrcConnQueryWidget::promptUserForConnInfo(), DtInOutForwarderPort::sendForwarderNodeInfoMsg(), DtRtiExecFederateMgr::sendJoinMsg(), DtRtiAssistantPeer::sendMsg(), DtRtiExec::sendRtiExecHandshakeMsg(), DtConnectionCache::setConnFromEnv(), DtAssistantConnQueryWidget::setEditEnabledBasedOnConn(), DtFederationsViewDialog::showForwarderInfo(), DtFederationsViewDialog::showRtiexecInfo(), DtRtiAssistantForwarderClient::updateForwarderInfo(), and DtAssistantFederationsViewMgr::updateRidParams().

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.

Referenced by DtNonBlockingPollInputLine().

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 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.

References NULL.

Referenced by DtFileDistributor::fedFileUploaded(), DtFedExec::isFomAvailable(), DtRtiExecFederateMgr::isFomAvailable(), and DtFileDistributor::sendFedFile().

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 )

References notifyLevel.

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.

Returns true if inserted, false if element already contained.