| blob | 710e0e240cbd07f6a9386463cb47cf32126ea078 |
1 /*********************************************************************
2 Copyright 2013 Karl Jones
3 All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
8 1. Redistributions of source code must retain the above copyright notice, this
9 list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright notice,
11 this list of conditions and the following disclaimer in the documentation
12 and/or other materials provided with the distribution.
14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 For Further Information Please Contact me at
26 Karljj1@yahoo.com
27 http://p.sf.net/kdis/UserGuide
28 *********************************************************************/
30 /********************************************************************
31 EnumEmitter
32 created: 17/09/2008
33 author: Karl Jones
35 purpose: Enums for emitter params
36 *********************************************************************/
38 #pragma once
46 /************************************************************************/
47 /* Emitter Name */
48 /* Emitter Name */
49 /* Used In: */
50 /* Emitter System */
51 /************************************************************************/
53 enum EmitterName
54 {
1211 };
1213 // Returns number of values in the EnumDescriptor for this enum.
1214 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1215 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1218 // Returns the EnumDescriptor value for the specified index.
1219 // Use GetEnumSize<enum> to get the array size.
1220 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1225 // Returns true if a value was found.
1228 /************************************************************************/
1229 /* Emitter Function */
1230 /* Function of a particular beam */
1231 /* Used In: */
1232 /* Emitter Beam */
1233 /************************************************************************/
1235 enum EmitterFunction
1236 {
1303 };
1305 // Returns number of values in the EnumDescriptor for this enum.
1306 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1307 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1310 // Returns the EnumDescriptor value for the specified index.
1311 // Use GetEnumSize<enum> to get the array size.
1312 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1317 // Returns true if a value was found.
1318 KDIS_EXPORT KBOOL GetEnumFromStringEmitterFunction( const KString & Value, KINT32 & ValueOut );
1320 /************************************************************************/
1321 /* State Update Indicator */
1322 /* Contains Event types */
1323 /* Used In: */
1324 /* Electromagnetic Emission PDU */
1325 /************************************************************************/
1327 enum StateUpdateIndicator
1328 {
1331 };
1333 // Returns number of values in the EnumDescriptor for this enum.
1334 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1335 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1338 // Returns the EnumDescriptor value for the specified index.
1339 // Use GetEnumSize<enum> to get the array size.
1340 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1345 // Returns true if a value was found.
1346 KDIS_EXPORT KBOOL GetEnumFromStringStateUpdateIndicator( const KString & Value, KINT32 & ValueOut );
1348 /************************************************************************/
1349 /* High Density Track/Jam */
1350 /* Indicates if the receiving simulation application can assume that all*/
1351 /* targets, in the scan pattern which the sending emitter can track or */
1352 /* jam are being tracked/jammed/ When selected the system issuing the */
1353 /* PDU shall not include any entities in the track/jam field. */
1354 /* Used In: */
1355 /* Electromagnetic Emission PDU */
1356 /************************************************************************/
1358 enum HighDensityTrackJam
1359 {
1362 };
1364 // Returns number of values in the EnumDescriptor for this enum.
1365 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1366 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1369 // Returns the EnumDescriptor value for the specified index.
1370 // Use GetEnumSize<enum> to get the array size.
1371 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1376 // Returns true if a value was found.
1377 KDIS_EXPORT KBOOL GetEnumFromStringHighDensityTrackJam( const KString & Value, KINT32 & ValueOut );
1379 #if DIS_VERSION > 6
1381 /************************************************************************/
1382 /* Beam State - UID 318 */
1383 /* Indicates if the state of the beam. */
1384 /* Used In: */
1385 /* Electromagnetic Emission PDU - Emitter Beam record */
1386 /************************************************************************/
1388 enum BeamState
1389 {
1392 };
1394 // Returns number of values in the EnumDescriptor for this enum.
1395 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1396 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1399 // Returns the EnumDescriptor value for the specified index.
1400 // Use GetEnumSize<enum> to get the array size.
1401 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1406 // Returns true if a value was found.
1409 #endif
1412 /************************************************************************/
1413 /* Beam Function (UID 78) */
1414 /* Specifies the function of a specific beam */
1415 /* Used In: */
1416 /* Electromagnetic_Emission_PDU */
1417 /************************************************************************/
1419 enum BeamFunction
1420 {
1445 };
1447 // Returns number of values in the EnumDescriptor for this enum.
1448 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1449 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1452 // Returns the EnumDescriptor value for the specified index.
1453 // Use GetEnumSize<enum> to get the array size.
1454 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1459 // Returns true if a value was found.
1462 /************************************************************************/
1463 /* Passive Parameter Index */
1464 /* Indicates which database record ( or file ) shall */
1465 /* used in the definition of passive signature (unintentional) */
1466 /* emissions of the entity. */
1467 /* Used In: */
1468 /* Underwater_Acoustic_PDU */
1469 /************************************************************************/
1471 enum PassiveParameterIndex
1472 {
1474 };
1476 // Returns number of values in the EnumDescriptor for this enum.
1477 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1478 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1481 // Returns the EnumDescriptor value for the specified index.
1482 // Use GetEnumSize<enum> to get the array size.
1483 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1488 // Returns true if a value was found.
1489 KDIS_EXPORT KBOOL GetEnumFromStringPassiveParameterIndex( const KString & Value, KINT32 & ValueOut );
1491 /************************************************************************/
1492 /* Additional Passive Parameter Index */
1493 /* Indicates which database record ( or file ) shall be used to describe*/
1494 /* an additional acoustic source such as transient effects, pre-launch */
1495 /* data( i.e torpedo tube floodings ), additional sources, and the */
1496 /* states available for each source type. This index shall be used to */
1497 /* identify data from databases such as the Special Event Database */
1498 /* ( SEDB )and an Additional Narrowband Database ( ANDB ). */
1499 /* Used In: */
1500 /* Underwater_Acoustic_PDU */
1501 /************************************************************************/
1503 enum AdditionalPassiveParameterIndex
1504 {
1507 // >32768 Reserved for classified enumerations
1508 // Point of Contact =
1509 };
1511 // Returns number of values in the EnumDescriptor for this enum.
1512 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1513 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1516 // Returns the EnumDescriptor value for the specified index.
1517 // Use GetEnumSize<enum> to get the array size.
1518 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1519 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorAdditionalPassiveParameterIndex( KUINT32 Index );
1523 // Returns true if a value was found.
1524 KDIS_EXPORT KBOOL GetEnumFromStringAdditionalPassiveParameterIndex( const KString & Value, KINT32 & ValueOut );
1526 /************************************************************************/
1527 /* Propulsion Plant Configuration */
1528 /* Used to determine the passive signature characteristics of an entity */
1529 /* Bit 7 is used to indicate hull mounted marker status */
1530 /* HMMS = Hull Mounted Marker Status */
1531 /* Used In: */
1532 /* Underwater_Acoustic_PDU */
1533 /************************************************************************/
1535 enum PropulsionPlantConfiguration
1536 {
1551 };
1553 // Returns number of values in the EnumDescriptor for this enum.
1554 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1555 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1558 // Returns the EnumDescriptor value for the specified index.
1559 // Use GetEnumSize<enum> to get the array size.
1560 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1561 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorPropulsionPlantConfiguration( KUINT32 Index );
1565 // Returns true if a value was found.
1566 KDIS_EXPORT KBOOL GetEnumFromStringPropulsionPlantConfiguration( const KString & Value, KINT32 & ValueOut );
1568 /************************************************************************/
1569 /* AcousticSystemName */
1570 /* Specifies the system for a UA emitter */
1571 /* Used In: */
1572 /* Underwater_Acoustic_PDU - Acoustic Emitter System */
1573 /************************************************************************/
1575 enum AcousticSystemName
1576 {
1587 };
1589 // Returns number of values in the EnumDescriptor for this enum.
1590 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1591 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1594 // Returns the EnumDescriptor value for the specified index.
1595 // Use GetEnumSize<enum> to get the array size.
1596 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1601 // Returns true if a value was found.
1602 KDIS_EXPORT KBOOL GetEnumFromStringAcousticSystemName( const KString & Value, KINT32 & ValueOut );
1604 /************************************************************************/
1605 /* AcousticSystemFunction */
1606 /* Describes the function of the acoustic system */
1607 /* Used In: */
1608 /* Underwater_Acoustic_PDU - Acoustic Emitter System */
1609 /************************************************************************/
1611 enum AcousticSystemFunction
1612 {
1618 };
1620 // Returns number of values in the EnumDescriptor for this enum.
1621 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1622 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1625 // Returns the EnumDescriptor value for the specified index.
1626 // Use GetEnumSize<enum> to get the array size.
1627 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1632 // Returns true if a value was found.
1633 KDIS_EXPORT KBOOL GetEnumFromStringAcousticSystemFunction( const KString & Value, KINT32 & ValueOut );
1635 /************************************************************************/
1636 /* Active Emission Parameter Index */
1637 /* Describes the function of the acoustic system */
1638 /* Used In: */
1639 /* Underwater_Acoustic_PDU - UA Fundamental Parameter Data */
1640 /************************************************************************/
1642 enum ActiveEmissionParameterIndex
1643 {
1645 };
1647 // Returns number of values in the EnumDescriptor for this enum.
1648 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1649 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1652 // Returns the EnumDescriptor value for the specified index.
1653 // Use GetEnumSize<enum> to get the array size.
1654 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1655 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorActiveEmissionParameterIndex( KUINT32 Index );
1659 // Returns true if a value was found.
1660 KDIS_EXPORT KBOOL GetEnumFromStringActiveEmissionParameterIndex( const KString & Value, KINT32 & ValueOut );
1662 /************************************************************************/
1663 /* Scan Pattern */
1664 /* Desscribes the UA scan pattern */
1665 /* Used In: */
1666 /* Underwater_Acoustic_PDU - UA Fundamental Parameter Data */
1667 /************************************************************************/
1669 enum ScanPattern
1670 {
1677 };
1679 // Returns number of values in the EnumDescriptor for this enum.
1680 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1681 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1684 // Returns the EnumDescriptor value for the specified index.
1685 // Use GetEnumSize<enum> to get the array size.
1686 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1691 // Returns true if a value was found.
1694 /************************************************************************/
1695 /* Power Setting */
1696 /* Represents the power settings after any response lags have been */
1697 /* incorprated */
1698 /* Used In: */
1699 /* SEES_PDU - Propulsion System */
1700 /************************************************************************/
1702 enum PowerSettingAircraft
1703 {
1709 };
1711 // Returns number of values in the EnumDescriptor for this enum.
1712 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1713 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1716 // Returns the EnumDescriptor value for the specified index.
1717 // Use GetEnumSize<enum> to get the array size.
1718 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1723 // Returns true if a value was found.
1724 KDIS_EXPORT KBOOL GetEnumFromStringPowerSettingAircraft( const KString & Value, KINT32 & ValueOut );
1726 enum PowerSettingHelicopter
1727 {
1731 };
1733 // Returns number of values in the EnumDescriptor for this enum.
1734 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1735 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1738 // Returns the EnumDescriptor value for the specified index.
1739 // Use GetEnumSize<enum> to get the array size.
1740 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1745 // Returns true if a value was found.
1746 KDIS_EXPORT KBOOL GetEnumFromStringPowerSettingHelicopter( const KString & Value, KINT32 & ValueOut );
1748 enum PowerSettingTank
1749 {
1753 };
1755 // Returns number of values in the EnumDescriptor for this enum.
1756 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
1757 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
1760 // Returns the EnumDescriptor value for the specified index.
1761 // Use GetEnumSize<enum> to get the array size.
1762 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
1767 // Returns true if a value was found.
1768 KDIS_EXPORT KBOOL GetEnumFromStringPowerSettingTank( const KString & Value, KINT32 & ValueOut );