include/vrfExtProtocol/msgTypes.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/******************************************************************************
** $RCSfile: msgTypes.h,v $ $Revision: 1.46 $ $State: Exp $
*******************************************************************************/
#ifndef msgTypes_H_
#define msgTypes_H_

//
// \file msgTypes.h
// \brief Defines constants for names of message related types.
//

#include <vlpi/disEnums.h>
#include <vrfExtProtocol/vrfExtProtocolDefines.h>

// Defines the safe range of values toolkit users can use for their own custom 
// interface messages (derived DtSimInterfaceContent types).
#define MIN_USER_INTERFACE_MESSAGE_TYPE 200
#define MAX_USER_INTERFACE_MESSAGE_TYPE 900

// Basic message types - these are used to distinguish radio messages
// from interface messages.
const int DtUnknownMessageType = 0;
const int DtVrfObjectMessageType = 1;
// \deprecated Same as DtVrfObjectMessageType.
const int DtRadioMessageType = DtVrfObjectMessageType;
const int DtInterfaceMessageType = 2;

// Radio message types - these are used to distinguish task radio messages
// from report radio messages.
const int DtUnknownRadioMessageType = 0;
const int DtTaskMessageType = 1;
const int DtReportMessageType = 2;
const int DtSetDataRequestMessageType = 3;
const int DtAdminMessageType = 4;

// The DtDatumParam enum is used to specify either an interface message kind or a 
// session ID inside a DataInteraction.  For interface messages, the enum value
// will be between 260000 and 261000.  For the session ID, we will use 261001.  For
// the message version, we will use 361002

const DtDatumParam DtDatumSessionId = DtDatumParam(261001);
const DtDatumParam DtDatumVrfMessageVersionId = DtDatumParam(261002);

// Interface content message names;  for all intents and purposes, interface 
// messages are named after their content, so we call these mesage names, not 
// just content names.  Use interface content message names to register 
// callbacks with interface message executives.

// The DtDatumParam used to specify interface message types in Data 
// Interactions is the message type plus this base.  These two constants together
// define a range of dataum params reserved to VR-Forces.

const DtDatumParam DtInterfaceMessageTypeDatumParamBase = DtDatumParam(260000);
const DtDatumParam DtInterfaceMessageTypeDatumParamLast = DtDatumParam(261000);

const int DtUnknownInterfaceMessageType = 0;

const int DtCreateVrfObjectMessageType = 5;
const int DtModifyVrfObjectMessageType = 6;
const int DtDeleteVrfObjectMessageType = 7;
const int DtVrfObjectCreatedMessageType = 8;
const int DtRequestVrfObjectCreatedMessageType = 9;
const int DtVrfObjectDeletedMessageType = 10;

const int DtDuplicateNameDetectedMessageType = 19;
const int DtControlMessageType = 20;
const int DtOverlayOpMessageType = 21;
const int DtPlanOpMessageType = 22;
const int DtOrderOfBattleOpMessageType = 23;
// \deprecated DtSimTaskManager now calls DtVrfObjectPlanManager::awaitingTask
const int DtAwaitingTaskMessageType__obsolete__ = 25;
const int DtSkipTaskMessageType = 26;
const int DtDeliverVrfObjectMessageType = 27;
// \deprecated Use DtDeliverVrfObjectMessageType instead.
const int DtDeliverRadioMessageType = DtDeliverVrfObjectMessageType;
const int DtSetTimeMultiplierMessageType = 28;
const int DtSetFrameModeMessageType = 29;
const int DtSetRandomSeedMessageType = 30;
const int DtFrameRateRequestMessageType = 31;
const int DtFrameRateResponseMessageType = 32;
const int DtAutoReorganizeMessageType = 33;
const int DtReorganizeMessageType = 34;
const int DtObsoleteAggregateAsMessageType = 35;  // not used
const int DtRequestPlanMessageType = 36;
const int DtPlanMessageType = 37;
const int DtRequestPlanStatementMessageType = 38;
const int DtPlanStatementMessageType = 39;
const int DtPlanCurStatementMessageType = 41;
const int DtAbandonPlanMessageType = 42;
const int DtSetBatchNumberMessageType  = 43; // not used
const int DtIfJoyDeviceRequestType = 44;
const int DtExitMessageType = 45;
const int DtObjectParametersOpMessageType = 46;
const int DtTerrainOpMessageType = 47;
const int DtLoadScenarioMessageType = 48;
const int DtStatusRequestMessageType = 49;
const int DtStatusMessageType = 50;
const int DtCloseScenarioMessageType = 51;
const int DtModifyOrganizationType = 52;
const int DtOrganizationModifiedType = 53;
const int DtAddToOrganizationType = 54;
const int DtRemoveFromOrganizationType = 55;
#ifndef UNDOCUMENTED
// ~~~~~~~~Engineering Addition
const int DtSpawnBreachMessageType = 56;
#endif /* UNDOCUMENTED */
const int DtPlanResponseMessageType = 57;
const int DtVrfObjectDataMessageType = 58;
const int DtParentChangedMessageType = 59;
const int DtInitConnectionMessageType = 60;
const int DtObsoleteLoadScenarioMessageType = 61;
const int DtLoadCompleteMessageType = 62;
const int DtSaveScenarioMessageType = 63;
const int DtSaveCompleteMessageType = 64;
const int DtDeleteVrfObjectByIdMessageType = 65;
const int DtAggregateAsMessageType = 66;
const int DtModifyVrfOverlayMessageType = 67;
const int DtSetThresholdsMessageType = 68;
// Stealth messages are obsolete after VRF 3.9.  69-72 are here for legacy reasons only.
const int DtStealthCompassMessageType = 69;
const int DtStealthMimicMessageType = 70;
const int DtStealthDetachMessageType = 71;
const int DtStealthGroupMessageType = 72;
const int DtResourceMonitorRequestMessageType = 73;
const int DtCurrentResourceRequestMessageType = 74;
const int DtResourceMonitorResponseMessageType = 75;
const int DtEntityResourceResponseMessageType = 76;
const int DtResourceNamesRequestMessageType = 77;
const int DtResourceNamesResponseMessageType = 78;
const int DtResourceMonitorEnableMessageType = 79;
const int DtVrfObjectStateMessageType = 80;
const int DtSetSubordinateOrderType = 81;
const int DtQuerySpatialSubdivisionConfigurationType = 82;
const int DtSpatialSubdivisionConfigurationType = 83;
const int DtSetSpatialSubdivisionConfigurationType = 84;
const int DtEmbarkObjectMessageType = 85;
const int DtDisembarkObjectMessageType = 86;
const int DtEmbarkationInformationRequestType = 87;
const int DtEmbarkationInformationType = 88;
const int DtSensorDataMessageType = 89;
const int DtSensorDataRequestMessageType = 90;
const int DtSensorDataUnsubscribeMessageType = 91;
// Not used.
const int DtObsoleteSetObjectNotifyLevelType = 92;
const int DtObsoleteLogObjectConsoleToFileType = 93;
const int DtObsoleteStopLogObjectConsoleToFileType = 94;
const int DtCapableTaskAndSetQueryType = 95;
const int DtCapableTaskAndSetResponseType = 96;
// New type for old created message
const int DtVrfObjectCreatedV2MessageType = 97;
const int DtRequestGlobalPlanListMessageType = 98;
const int DtGlobalPlanListMessageType = 99;
const int DtRequestGlobalPlanMessageType = 100;
const int DtDeletePlanMessageType = 101;
const int DtRadioMessageReceivedMessageType = 102;

const int DtMultiplePlanRequestMessageType = 103;
const int DtMultiplePlanResponseMessageType = 104;
const int DtMultiplePlanSetMessageType = 105;
const int DtPluginDataMessageType = 106;
const int DtPluginDataRequestMessageType = 107;
const int DtRestartPlanMessageType = 108;

const int DtDIGuyAppearAndAnimationsQueryType = 109;
const int DtDIGuyAppearAndAnimationsResponseType = 110;

const int DtIndirectArtilleryMessageType = 111;

const int DtRequestHostilityMatrixMessageType=112;
const int DtSetHostilityMatrixMessageType=113;
const int DtHostilityMatrixMessageType=114;
const int DtRequestForceHostilityMessageType=115;
const int DtSetForceHostilityMessageType=116;
const int DtForceHostilityMessageType=117;
const int DtExecuteSimCommandMessageType=118;

const int DtModifySettingMessageType = 119;
const int DtRequestSettingMessageType = 120;
const int DtSettingMessageType = 121;

const int DtSubordinateListMessageType = 122;
const int DtSubordinateListRequestMessageType = 123;

const int DtSplitContentType = 124;

const int DtSwitchSystemResponseMessageType = 125;

const int DtIfObjectIndexMessageType = 126;

const int DtServerMessageType = 127;

//const int DtScenarioDescriptionMessageType = 128;

// This integer is only used by the entity publisher and entity reflected list to handle
// requests for object data messages
const int DtRequestVrfObjectData = 24326;
const int DtVrfObjectDataType = 24327;

// These are aliases for back compatibility
const int DtModifyControlObjectMessageType = DtModifyVrfObjectMessageType;
const int DtModifyControlAreaMessageType = DtModifyVrfObjectMessageType;
const int DtModifyControlPointMessageType = DtModifyVrfObjectMessageType;
const int DtModifyRouteMessageType = DtModifyVrfObjectMessageType;
const int DtModifyPhaseLineMessageType = DtModifyVrfObjectMessageType;
const int DtModifyGroundObstacleMessageType = DtModifyVrfObjectMessageType;
const int DtRemoveEntityMessageType = DtDeleteVrfObjectMessageType;
const int DtRemoveControlObjectMessageType = DtDeleteVrfObjectMessageType;
const int DtEntityNameMessageType = DtVrfObjectCreatedMessageType;
const int DtCreateEntityMessageType = DtCreateVrfObjectMessageType;
const int DtCreateControlObjectMessageType = DtCreateVrfObjectMessageType;
const int DtCreatePhaseLineMessageType = DtCreateVrfObjectMessageType;
const int DtCreateRouteMessageType = DtCreateVrfObjectMessageType;
const int DtCreateControlAreaMessageType = DtCreateVrfObjectMessageType;
const int DtCreateControlPointMessageType = DtCreateVrfObjectMessageType;
const int DtCreateGroundObstacleMessageType = DtCreateVrfObjectMessageType;
const int DtCreateTargetPointMessageType = DtCreateVrfObjectMessageType;
const int DtRequestEntityNameMessageType = DtRequestVrfObjectCreatedMessageType;
const int DtEntityParametersOpMessageType = DtObjectParametersOpMessageType;

// Control messages contain a control type; more will probably be added.
const int DtUnknownControlType = 0;
const int DtPauseControlType = 1;
const int DtRunControlType = 2;
const int DtRunDurationControlType = 3;
const int DtRunCompleteControlType = 4;
const int DtRewindControlType = 5;
const int DtStepControlType = 6;

// These are used in the different file operation messages; more will probably
// be added.
const int DtUnknownFileOpType = 0;
const int DtReadFileOpType = 1;
const int DtWriteFileOpType = 2;

// These are used for the different frame modes in the frame mode message.
enum DtFrameMode
{
   DtUnknownFrameModeType,
   DtVariableFrameModeType,
   DtFixedFrameModeType,
   DtFixedFrameRunToCompleteModeType
};

const char DtUnknownFrameModeTypeString[] = "unknown-frame";
const char DtVariableFrameModeTypeString[] = "variable-frame";
const char DtFixedFrameModeTypeString[] = "fixed-frame";
const char DtFixedFrameRunToCompleteModeTypeString[] = "fixed-frame-run-to-complete";

// Task message contents are tasks, whose names are defined in taskTypes.h.

// Type printing functions
DT_DLL_vrfExtProtocol extern const char* DtFrameModeTypeString(DtFrameMode type);
DT_DLL_vrfExtProtocol extern const char* DtFileOpTypeString(int type);
DT_DLL_vrfExtProtocol extern const char* DtInterfaceContentTypeString(int type);
DT_DLL_vrfExtProtocol extern const char* DtControlTypeString(int type);
DT_DLL_vrfExtProtocol extern const char* DtRadioMessageTypeString(int type);
DT_DLL_vrfExtProtocol extern const char* DtMessageTypeString(int type);

#endif