assistantSignalIds.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2016 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vlutil/vlString.h>
#include <vlutil/vlPrint.h>

enum DtAssistantSignalId
{
   // <---- Start configuration parameter signals
   DtLogUpdateIntervalUpdatedSig,
   DtKeepAliveUpdatedSig,
   DtSendForeignQueryUpdatedSig,
   DtLatencyTestInteractionPeriodMsUpdatedSig,
   DtLatencyTestNumInteractionsUpdatedSig,
   DtLatencyTestPayloadBytesUpdatedSig,
   DtDisplayPopupsAsNotificationsUpdatedSig,
   DtEnableNotificationsUpdatedSig,
   DtLightweightMemorySecUpdatedSig,
   DtDefunctFederateRemovalTimeSecUpdatedSig,
   DtAssistantUpdateIntervalSecUpdatedSig,
   DtLrcUpdateIntervalSecUpdatedSig,
   DtShowRtiexecStartupPromptUpdatedSig,
   DtAcceptRemoteCommandsUpdatedSig,
   DtAssistantPersistentUpdatedSig,
   DtDefaultToUnlicensedUpdatedSig,
   DtWarningTickIntervalUpdatedSig,
   DtDisplayRemoteNotificationsUpdatedSig,
   DtDisplayFederationColorsUpdatedSig,
   DtFederateIdentifierUpdatedSig,
   DtUpdateLogUpdateIntervalSig,
   DtUpdateKeepAliveSig,
   DtUpdateSendForeignQuerySig,
   DtUpdateLatencyTestInteractionPeriodMsSig,
   DtUpdateLatencyTestNumInteractionsSig,
   DtUpdateLatencyTestPayloadBytesSig,
   DtUpdateDisplayPopupsAsNotificationsSig,
   DtUpdateEnableNotificationsSig,
   DtUpdateLightweightMemorySecSig,
   DtUpdateDefunctFederateRemovalTimeSecSig,
   DtUpdateAssistantUpdateIntervalSecSig,
   DtUpdateLrcUpdateIntervalSecSig,
   DtUpdateShowRtiexecStartupPromptSig,
   DtUpdateAcceptRemoteCommandsSig,
   DtUpdateAssistantPersistentSig,
   DtUpdateDefaultToUnlicensedSig,
   DtUpdateWarningTickIntervalSig,
   DtUpdateDisplayRemoteNotificationsSig,
   DtUpdateDisplayFederationColorsSig,
   DtUpdateFederateIdentifierSig,
   // End configuration parameter signals ----->
   DtSavePreferencesSig,
   DtShowConfigSig,
   DtShowConfigPageSig,
   DtUpdateLocalComponentSig,
   DtLrcComponentAddedSig,
   DtRtiexecComponentAddedSig,
   DtForwarderComponentAddedSig,
   DtSharedMemComponentAddedSig,
   DtLrcComponentRemovedSig,
   DtRtiexecComponentRemovedSig,
   DtForwarderComponentRemovedSig,
   DtSharedMemComponentRemovedSig,
   DtLrcComponentRemovedUnexpectedlySig,
   DtRtiexecComponentRemovedUnexpectedlySig,
   DtForwarderComponentRemovedUnexpectedlySig,
   DtSharedMemComponentRemovedUnexpectedlySig,
   DtLrcComponentRenamedSig,
   DtRtiexecComponentRenamedSig,
   DtForwarderComponentRenamedSig,
   DtSharedMemComponentRenamedSig,
   DtLrcComponentConnectedSig,
   DtRtiexecComponentConnectedSig,
   DtForwarderComponentConnectedSig,
   DtLrcComponentDisconnectedSig,
   DtRtiexecComponentDisconnectedSig,
   DtForwarderComponentDisconnectedSig,
   DtLrcComponentUpdatedSig,
   DtRtiexecComponentUpdatedSig,
   DtForwarderComponentUpdatedSig,
   DtSharedMemComponentUpdatedSig,
   DtLocalFederateJoinedSig,
   DtLocalFederateResignedSig,
   DtForwarderHasRtiexecSig,
   DtForwarderHasNoRtiexecSig,
   DtRtiConnHeartbeatSig,
   DtRtiConnPruneSig,
   DtRtiConnsAddedOrUpdatedSig,
   DtRtiConnsAboutToBeRemovedSig,
   DtRtiConnsRemovedSig,
   DtRemoteAssistantFoundSig,
   DtRemoteAssistantLostSig,
   DtRtiexecStartupExternalRequestSig,
   DtForwarderStartupExternalRequestSig,
   DtRtiexecStartupInternalRequestSig,
   DtForwarderStartupInternalRequestSig,
   DtFederationAddedSig,
   DtFederationUpdatedSig,
   DtFederationRemovedSig,
   DtFederateAddedSig,
   DtFederateUpdatedSig,
   DtFederateRemovedSig,
   DtRtiexecHasNoFederationsSig,
   DtForwarderAddedSig,
   DtForwarderConnUpdatedSig,
   DtForwarderUpdatedSig,
   DtForwarderRemovedSig,
   DtShutdownSig,
   DtDisplayActiveWarningDialogsSig,
   DtShowLrcLatencyTestDialogSig,
   DtShowRtiexecLatencyTestDialogSig,
   DtDisplayRemoteFederateStatsDialogSig,
   DtShowFederationsDialogSig,
   DtRefreshFederationsDialogSig,
   DtRefreshRidConfigurationListSig,
   DtShowNetworkComponentsDialogSig,
   DtDisableCompLatencyTestSig,
   DtEnableCompLatencyTestSig,
   DtShowAboutBoxSig,
   DtLocalCompNotificationSig,
   DtNotificationSig,
   DtLocalCompPopupSig,
   DtPopupSig,
   DtWarningDialogDisplayedSig,
   DtWarningDialogDismissedSig,
   DtRequestFederateLocSig,
   DtFederateLocReceivedSig,
   DtDisplayComponentLogSig,
   DtDisplayFomDialogSig,
   DtConnQuerySig,
   DtAddWanConnectionSig,
   DtRemoveWanConnectionSig,
   DtWanConnectionConnectSig,
   DtWanConnectionDisconnectSig,
   DtWanConnectionAddedSig,
   DtWanConnectionRemovedSig,
   DtWanConnectionUpdatedSig,
   DtWanConnectionInfoUpdatedSig,
   DtRtiSettingsNameSelectedSig,

   DtNumAssistantSignalIds
};

#define DtSTRINGIFY_SIG_ID(id) \
   case id: \
   output = #id; \
   break;

inline std::ostream& operator<<( std::ostream& str, DtAssistantSignalId id )
{
   MAKRti::DtString output;
   switch(id)
   {
      DtSTRINGIFY_SIG_ID(DtLogUpdateIntervalUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtKeepAliveUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtSendForeignQueryUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLatencyTestInteractionPeriodMsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLatencyTestNumInteractionsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLatencyTestPayloadBytesUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtDisplayPopupsAsNotificationsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtEnableNotificationsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLightweightMemorySecUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtDefunctFederateRemovalTimeSecUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtAssistantUpdateIntervalSecUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLrcUpdateIntervalSecUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtShowRtiexecStartupPromptUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtAcceptRemoteCommandsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtAssistantPersistentUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtDefaultToUnlicensedUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtWarningTickIntervalUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtDisplayRemoteNotificationsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtDisplayFederationColorsUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtFederateIdentifierUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLogUpdateIntervalSig)
      DtSTRINGIFY_SIG_ID(DtUpdateKeepAliveSig)
      DtSTRINGIFY_SIG_ID(DtUpdateSendForeignQuerySig)
      DtSTRINGIFY_SIG_ID(DtUpdateLatencyTestInteractionPeriodMsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLatencyTestNumInteractionsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLatencyTestPayloadBytesSig)
      DtSTRINGIFY_SIG_ID(DtUpdateDisplayPopupsAsNotificationsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateEnableNotificationsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLightweightMemorySecSig)
      DtSTRINGIFY_SIG_ID(DtUpdateDefunctFederateRemovalTimeSecSig)
      DtSTRINGIFY_SIG_ID(DtUpdateAssistantUpdateIntervalSecSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLrcUpdateIntervalSecSig)
      DtSTRINGIFY_SIG_ID(DtUpdateShowRtiexecStartupPromptSig)
      DtSTRINGIFY_SIG_ID(DtUpdateAcceptRemoteCommandsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateAssistantPersistentSig)
      DtSTRINGIFY_SIG_ID(DtUpdateDefaultToUnlicensedSig)
      DtSTRINGIFY_SIG_ID(DtUpdateWarningTickIntervalSig)
      DtSTRINGIFY_SIG_ID(DtUpdateDisplayRemoteNotificationsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateDisplayFederationColorsSig)
      DtSTRINGIFY_SIG_ID(DtUpdateFederateIdentifierSig)
      DtSTRINGIFY_SIG_ID(DtSavePreferencesSig)
      DtSTRINGIFY_SIG_ID(DtShowConfigSig)
      DtSTRINGIFY_SIG_ID(DtShowConfigPageSig)
      DtSTRINGIFY_SIG_ID(DtUpdateLocalComponentSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentAddedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentAddedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentAddedSig)
      DtSTRINGIFY_SIG_ID(DtSharedMemComponentAddedSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentRemovedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentRemovedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentRemovedSig)
      DtSTRINGIFY_SIG_ID(DtSharedMemComponentRemovedSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentRemovedUnexpectedlySig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentRemovedUnexpectedlySig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentRemovedUnexpectedlySig)
      DtSTRINGIFY_SIG_ID(DtSharedMemComponentRemovedUnexpectedlySig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentRenamedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentRenamedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentRenamedSig)
      DtSTRINGIFY_SIG_ID(DtSharedMemComponentRenamedSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentConnectedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentConnectedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentConnectedSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentDisconnectedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentDisconnectedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentDisconnectedSig)
      DtSTRINGIFY_SIG_ID(DtLrcComponentUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecComponentUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderComponentUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtSharedMemComponentUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtLocalFederateJoinedSig)
      DtSTRINGIFY_SIG_ID(DtLocalFederateResignedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderHasRtiexecSig)
      DtSTRINGIFY_SIG_ID(DtForwarderHasNoRtiexecSig)
      DtSTRINGIFY_SIG_ID(DtRtiConnHeartbeatSig)
      DtSTRINGIFY_SIG_ID(DtRtiConnPruneSig)
      DtSTRINGIFY_SIG_ID(DtRtiConnsAddedOrUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtRtiConnsAboutToBeRemovedSig)
      DtSTRINGIFY_SIG_ID(DtRtiConnsRemovedSig)
      DtSTRINGIFY_SIG_ID(DtRemoteAssistantFoundSig)
      DtSTRINGIFY_SIG_ID(DtRemoteAssistantLostSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecStartupExternalRequestSig)
      DtSTRINGIFY_SIG_ID(DtForwarderStartupExternalRequestSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecStartupInternalRequestSig)
      DtSTRINGIFY_SIG_ID(DtForwarderStartupInternalRequestSig)
      DtSTRINGIFY_SIG_ID(DtFederationAddedSig)
      DtSTRINGIFY_SIG_ID(DtFederationUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtFederationRemovedSig)
      DtSTRINGIFY_SIG_ID(DtFederateAddedSig)
      DtSTRINGIFY_SIG_ID(DtFederateUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtFederateRemovedSig)
      DtSTRINGIFY_SIG_ID(DtRtiexecHasNoFederationsSig)
      DtSTRINGIFY_SIG_ID(DtForwarderAddedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderConnUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtForwarderRemovedSig)
      DtSTRINGIFY_SIG_ID(DtShutdownSig)
      DtSTRINGIFY_SIG_ID(DtDisplayActiveWarningDialogsSig)
      DtSTRINGIFY_SIG_ID(DtShowLrcLatencyTestDialogSig)
      DtSTRINGIFY_SIG_ID(DtShowRtiexecLatencyTestDialogSig)
      DtSTRINGIFY_SIG_ID(DtDisplayRemoteFederateStatsDialogSig)
      DtSTRINGIFY_SIG_ID(DtShowFederationsDialogSig)
      DtSTRINGIFY_SIG_ID(DtRefreshFederationsDialogSig)
      DtSTRINGIFY_SIG_ID(DtRefreshRidConfigurationListSig)
      DtSTRINGIFY_SIG_ID(DtShowNetworkComponentsDialogSig)
      DtSTRINGIFY_SIG_ID(DtDisableCompLatencyTestSig)
      DtSTRINGIFY_SIG_ID(DtEnableCompLatencyTestSig)
      DtSTRINGIFY_SIG_ID(DtShowAboutBoxSig)
      DtSTRINGIFY_SIG_ID(DtLocalCompNotificationSig)
      DtSTRINGIFY_SIG_ID(DtNotificationSig)
      DtSTRINGIFY_SIG_ID(DtLocalCompPopupSig)
      DtSTRINGIFY_SIG_ID(DtPopupSig)
      DtSTRINGIFY_SIG_ID(DtWarningDialogDisplayedSig)
      DtSTRINGIFY_SIG_ID(DtWarningDialogDismissedSig)
      DtSTRINGIFY_SIG_ID(DtRequestFederateLocSig)
      DtSTRINGIFY_SIG_ID(DtFederateLocReceivedSig)
      DtSTRINGIFY_SIG_ID(DtDisplayComponentLogSig)
      DtSTRINGIFY_SIG_ID(DtDisplayFomDialogSig)
      DtSTRINGIFY_SIG_ID(DtConnQuerySig)
      DtSTRINGIFY_SIG_ID(DtAddWanConnectionSig)
      DtSTRINGIFY_SIG_ID(DtRemoveWanConnectionSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionAddedSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionRemovedSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionConnectSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionDisconnectSig)
      DtSTRINGIFY_SIG_ID(DtWanConnectionInfoUpdatedSig)
      DtSTRINGIFY_SIG_ID(DtRtiSettingsNameSelectedSig)
      
   default:
      output = id;
      break;
   }
   return str << output;
}

enum DtAssistantQueryId
{
   // TODO: We don't have many "query" signals/slots right now, but I would like
   // to eventually add more so that no managers have any knowledge of any
   // other managers. Query signals need to have some kind of response. Since
   // signals happen synchronously, the response should either be in some
   // parameter passed by reference or a pointer to a pointer.
   //    DtLocalComponentQuery,
   //    DtAllLocalComponentsQuery,
   //    DtLocalRtiexecsQuery,
   //    DtLocalForwardersQuery,
   //    DtLocalSharedMemQuery,
   //    DtPrintLocalComponentsQuery,
   //    DtPrintFederationListQuery,
   //    DtPrintRtiexecComponentsQuery,
   //    DtPrintForwarderComponentsQuery,

   DtFederateInfoQuery,
   DtFederationInfoQuery,
   DtForwarderInfoQuery,
   DtPeerForwarderInfoQuery,
   DtPeerForwarderConnectionsQuery,
   DtAssistantInfoQuery,
   DtRecoverConnectionInfoQuery,

   DtNumAssistantQueryIds
};


inline std::ostream& operator<<( std::ostream& str, DtAssistantQueryId id )
{
   MAKRti::DtString output;
   switch(id)
   {
      DtSTRINGIFY_SIG_ID(DtFederateInfoQuery)
      DtSTRINGIFY_SIG_ID(DtFederationInfoQuery)
      DtSTRINGIFY_SIG_ID(DtForwarderInfoQuery)
      DtSTRINGIFY_SIG_ID(DtPeerForwarderInfoQuery)
      DtSTRINGIFY_SIG_ID(DtAssistantInfoQuery)
      DtSTRINGIFY_SIG_ID(DtRecoverConnectionInfoQuery)

   default:
      output = id;
      break;
   }
   return str << output;
}