include/vrfExtObjects/simAppInterOp.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: simAppInterOp.h,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/

#ifndef DtSimApplicationInteroperation_H_
#define DtSimApplicationInteroperation_H_

// This header file contains the definitions related to interoperabiltiy
// between VR-Forces applications.  VR-Forces applications encode echelon 
// information about the entities' (and aggregates') position with a military 
// hierarchy.  This is accomplished within the confines of the standard set of 
// PDUs (DIS), and the RPR FOM (HLA).

// The entity identifier is used to identify an entity in a DIS exercise or
// an HLA exercise using the RPR FOM (site Id/application Id/entity number).  
// VR-Forces application Ids are limited to falling with a specified range 
// (non VR-Forces should be assigned application Ids outside this range when 
// participating in exercises with VR-Forces applications).  The entity number
// is an integer generated internally by the VR-Forces application.
// 
// e.g. 225/3002/3, a remote vrforces entity
// 
// Lower limit for VR-Forces application Ids.
const int DtSimApplicationIdLowerLimit = 3000;

// Upper limit for VR-Forces application Ids.
const int DtSimApplicationIdUpperLimit = 4000;

#if DtHLA
// HLA
// The global object designators are encoded in the following manner for
// VR-Forces entities and aggregates:
// <prefix><character indicating top level superior><federate id>:<entity id>
// e.g. "VRF2:195", a remote VR-Forces entity, which should be attached to 
// lower-level superior (lower than force-level). 

// prefix - a short string tag identifying designator as one generated by a 
// VR-forces application.
const char DtSimAppPrefix[] = "VRF";

#if DtHLA_1516
const char DtSimGlobalObjectDesignatorFormat[] = "%3.3s%s:%d";
#else
// Global object designator format
const char DtSimGlobalObjectDesignatorFormat[] = "%3.3s%d:%d";
#endif
#endif

// Format string for marking text.  Marking text exists for both DIS and 
// HLA/RPR.  It is used by VR-Forces to encode an entity's echelon Id 
// designator, category, superior-type information.  The first 3 characters 
// are reserved for the designator string, the next 6 characters are reserved
// for the category, and the final character is reserved for a single character
// indicating if the entity is attached to a top-level superior (force level).
// If the last character is a '*', then the entity should be attached to a 
// force-level superior, otherwise it should be attached to some lower-level 
// superior.
//
// e.g. "  1  M1A1*"

const int DtSimMaxEncodedMarkingLength = 10;
const int DtSimMaxDesignatorLength = 3;
const int DtSimMaxCategoryLength = 6;
const char DtSimMarkingFormat[] = "%3.3s%6.6s%1.1c";
 
// top-level superior character
const char DtSimTopLevelSuperiorChar = '*';


#endif