DtModelSemanticsMapper.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2023 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 

 
#ifndef DtModelSemanticsMapper_H_ 
#define DtModelSemanticsMapper_H_ 
 
#include <vrvCore/vrvCore.h> 
#include <vrvUtil/DtVirtualBaseClass.h>

#include <map>
#include <string>

namespace makVrv 
{ 
   class DtDe;
   class DtBaseConnection;
   class DT_DLL_VRVCORE DtModelSemanticsMapper : public DtVirtualBaseClass
   {
   public:

      friend class DtModelSemanticsMapperCreator;

      struct States
      {
         //The default state ids, note using a string of the exact text of an enumeration 
         //is a valid name for the id.
         enum Id
         {
            invalidId = 0,
            mobility = 1,
            fire_power = 2,
            damage = 3,
            trailing_effects = 4,
            hatch = 5,
            moving = 6,
            paint_scheme = 7,
            density = 8,
            frozen_status = 9,
            power_plant_status = 10,
            launcher = 11,
            camouflage_type = 12,
            concealed = 13,
            head_lights = 14,
            tail_lights = 15,
            brake_lights = 16,
            blackout_lights = 17,
            blackout_brake_lights = 18,
            spot_lights = 19,
            interior_lights = 20,
            afterburner = 21,
            landing_lights = 22,
            navigation_lights = 23,
            anticollision_lights = 24,
            formation_lights = 25,
            launch_flash = 26,
            smoke = 27,
            flaming = 28,
            running_lights = 29,
            lights = 30,
            life_form_state = 31,
            weapon_1 = 32,
            weapon_2 = 33,
            flashlight = 34,
            compliance = 35,
            health = 36,
            masked_cloaked = 37,
            internal_heat_status = 38,
            exterior_lights = 39,
            mission = 40,
            antenna = 41,
            tent = 42,
            ramp = 43,
            wind_effect = 50, // things that change state due to wind
            light_color = 51, // switch for light color on buoys and beacons
            daymark = 52, // switch for daymark sign on beacons
            daymark_shape = 53, // switch for daymark sign shape on beacons
            topmark = 54, // switch for topmarks on beacons or buoys
            topmark_shape = 55, // switch for topmark shapes on beacons or buoys
            label_char_count = 56, // switch for number of characters on a label, 
            // with characters determined by UV offset into an atlas
            shadow_polygon = 57, // switch for shadow polygon underneath cars and other objects
            segment_count = 58, // switch for number of characters on a taxiway sign, 
            // with characters determined by UV offset into an atlas
            // switch for the color of the expendable 
            exp_color = 59,
            exp_parachute = 60,  // expendable parachute state
            lower_anti_collision_lights = 61,
            upper_anti_collision_lights = 62,
            anti_collision_lights_day_night = 63,
            is_blinking = 64,
            landing_gear_extended = 65,
            cargo_doors_opened = 66, 
            navigation_position_brightness = 67,
            reverse_thrust_engaged = 68,
            weight_on_wheels = 69,
            occupants_surrendered = 70,
            nvg_mode = 71,
            cover_shroud = 72,
            signal_smoke = 73,
            signal_mirror = 74, 
            ir_strobe = 75,
            ir_illuminator = 76,
            mounted_status = 77,
            concealed_movement = 78,
            flare_smoke_status = 79,
            spot_chaff_status = 80,
            supply_deployed_status = 81,
            left_indicator_light = 82,
            right_indicator_light = 83,
            emergency_lights = 84,
            hdu_lights = 85,
            anchor_lights = 86,
            warning_safety_lights = 87,
            distress_beacons_strobes = 88,
            upper_deck_flood_lights = 89,
            upper_deck_lights = 90,
            wave_off_light = 91,
            not_under_command_lights = 92,
            ram_lights = 93, // restricted ability to maneuver
            fishing_with_lines_lights = 94,
            fishing_with_nets_lights = 95,
            mine_hunting_lights = 96,
            taxi_lights = 97,
            user_start       = 500
         };
      };

      struct Parts
      {
         enum Id
         {
            rudder = 1024,       // 32 X 32
            left_flap = 1056,    // 33 X 32
            right_flap = 1088,   // 34 X 32
            left_aileron = 1120, // etc. all art part numbers are multiples of 32
            right_aileron = 1152,
            helicopter_main_rotor = 1184,
            helicopter_tail_rotor = 1216,
            other_aircraft_control_surfaces_defined_as_needed = 1248,
            propeller_number_1 = 1280,
            propeller_number_2 = 1312,
            propeller_number_3 = 1344,
            propeller_number_4 = 1376,
            left_stabilator_stabilator_number_1 = 1408,
            right_stabilator_stabilator_number_2 = 1440,
            left_ruddervator_ruddervator_number_1 = 1472,
            right_ruddervator_ruddervator_number_2 = 1504,
            left_leading_edge_flap_slat = 1536,
            right_leading_edge_flap_slat = 1568,
            left_elevator = 1600,
            right_elevator = 1632,
            canard_left = 1664,
            canard_right = 1696,
            elevon_inner_left = 1728,
            elevon_inner_right = 1760,
            elevon_middle_left = 1792,
            elevon_middle_right = 1824,
            elevon_outer_left = 1856,
            elevon_outer_right = 1888,
            canopy_aircraft = 1920,
            periscope = 2048,
            generic_antenna = 2080,
            snorkel = 2112,
            other_extendible_parts_defined_as_needed = 2144,
            dive_plane_sail_left = 2176,
            dive_plane_sail_right = 2208,
            dive_plane_bow_left = 2240,
            dive_plane_bow_right = 2272,
            dive_plane_stern_left = 2304,
            dive_plane_stern_right = 2336,
            landing_gear = 3072,
            tail_hook = 3104,
            speed_brake = 3136,
            left_weapon_bay_door = 3168,
            right_weapon_bay_doors = 3200,
            tank_or_apc_hatch = 3232,
            wingsweep = 3264,
            bridge_launcher = 3296,
            bridge_section_1 = 3328,
            bridge_section_2 = 3360,
            bridge_section_3 = 3392,
            primary_blade_1 = 3424,
            primary_blade_2 = 3456,
            primary_boom = 3488,
            primary_launcher_arm = 3520,
            Landing_Gear_Nose = 3584,
            Landing_Gear_Left_Main = 3616,
            Landing_Gear_Right_Main = 3648,
            Doors_of_Left_Side_Weapon_Bay = 3680,
            Doors_of_Right_Side_Weapon_Bay = 3712,
            Spot_Search_Light_1 = 3744,
            Spot_Search_Light_2 = 3776,
            Spot_Search_Light_3 = 3808,
            Spot_Search_Light_4 = 3840,
            Landing_Light = 3872,
            other_fixed_position_parts_defined_as_needed = 3552,
            primary_turret_number_1 = 4096,
            primary_turret_number_2 = 4128,
            primary_turret_number_3 = 4160,
            primary_turret_number_4 = 4192,
            primary_turret_number_5 = 4224,
            primary_turret_number_6 = 4256,
            primary_turret_number_7 = 4288,
            primary_turret_number_8 = 4320,
            primary_turret_number_9 = 4352,
            primary_turret_number_10 = 4384,
            primary_gun_number_1 = 4416,
            primary_gun_number_2 = 4448,
            primary_gun_number_3 = 4480,
            primary_gun_number_4 = 4512,
            primary_gun_number_5 = 4544,
            primary_gun_number_6 = 4576,
            primary_gun_number_7 = 4608,
            primary_gun_number_8 = 4640,
            primary_gun_number_9 = 4672,
            primary_gun_number_10 = 4704,
            primary_launcher_1 = 4736,
            primary_launcher_2 = 4768,
            primary_launcher_3 = 4800,
            primary_launcher_4 = 4832,
            primary_launcher_5 = 4864,
            primary_launcher_6 = 4896,
            primary_launcher_7 = 4928,
            primary_launcher_8 = 4960,
            primary_launcher_9 = 4992,
            primary_launcher_10 = 5024,
            primary_defense_systems_1 = 5056,
            primary_defense_systems_2 = 5088,
            primary_defense_systems_3 = 5120,
            primary_defense_systems_4 = 5152,
            primary_defense_systems_5 = 5184,
            primary_defense_systems_6 = 5216,
            primary_defense_systems_7 = 5248,
            primary_defense_systems_8 = 5280,
            primary_defense_systems_9 = 5312,
            primary_defense_systems_10 = 5344,
            primary_radar_1 = 5376,
            primary_radar_2 = 5408,
            primary_radar_3 = 5440,
            primary_radar_4 = 5472,
            primary_radar_5 = 5504,
            primary_radar_6 = 5536,
            primary_radar_7 = 5568,
            primary_radar_8 = 5600,
            primary_radar_9 = 5632,
            primary_radar_10 = 5664,
            secondary_turret_number_1 = 5696,
            secondary_turret_number_2 = 5728,
            secondary_turret_number_3 = 5760,
            secondary_turret_number_4 = 5792,
            secondary_turret_number_5 = 5824,
            secondary_turret_number_6 = 5856,
            secondary_turret_number_7 = 5888,
            secondary_turret_number_8 = 5920,
            secondary_turret_number_9 = 5952,
            secondary_turret_number_10 = 5984,
            secondary_gun_number_1 = 6016,
            secondary_gun_number_2 = 6048,
            secondary_gun_number_3 = 6080,
            secondary_gun_number_4 = 6112,
            secondary_gun_number_5 = 6144,
            secondary_gun_number_6 = 6176,
            secondary_gun_number_7 = 6208,
            secondary_gun_number_8 = 6240,
            secondary_gun_number_9 = 6272,
            secondary_gun_number_10 = 6304,
            secondary_launcher_1 = 6336,
            secondary_launcher_2 = 6368,
            secondary_launcher_3 = 6400,
            secondary_launcher_4 = 6432,
            secondary_launcher_5 = 6464,
            secondary_launcher_6 = 6496,
            secondary_launcher_7 = 6528,
            secondary_launcher_8 = 6560,
            secondary_launcher_9 = 6592,
            secondary_launcher_10 = 6624,
            secondary_defense_systems_1 = 6656,
            secondary_defense_systems_2 = 6688,
            secondary_defense_systems_3 = 6720,
            secondary_defense_systems_4 = 6752,
            secondary_defense_systems_5 = 6784,
            secondary_defense_systems_6 = 6816,
            secondary_defense_systems_7 = 6848,
            secondary_defense_systems_8 = 6880,
            secondary_defense_systems_9 = 6912,
            secondary_defense_systems_10 = 6944,
            secondary_radar_1 = 6976,
            secondary_radar_2 = 7008,
            secondary_radar_3 = 7040,
            secondary_radar_4 = 7072,
            secondary_radar_5 = 7104,
            secondary_radar_6 = 7136,
            secondary_radar_7 = 7168,
            secondary_radar_8 = 7200,
            secondary_radar_9 = 7232,
            secondary_radar_10 = 7264,
            deck_Elevator_1 = 7296,
            deck_Elevator_2 = 7328,
            catapult_1 = 7360,
            catapult_2 = 7392,
            jet_blast_deflector_1 = 7424,
            jet_blast_deflector_2 = 7456,
            arrestor_wires_1 = 7488,
            arrestor_wires_2 = 7520,
            arrestor_wires_3 = 7552,
            wing__fold = 7584,
            rotor_fold = 7584,
            fuselage_fold = 7616,
            Main_Cargo_Door = 7648,
            cargo_ramp = 7680,
            air_to_air_refueling_boom = 7680,
            primary_aerial_refueling_receptacle_door = 7680,
            secondary_aerial_refueling_receptacle_door = 7776,
            aerial_refueling_receptacle_latch = 7808,
            cargo_door_1 = 7840,
            cargo_door_2 = 7872,
            cargo_door_3 = 7904,
            cargo_door_4 = 7936,
            cargo_door_5 = 7968,
            cargo_door_6 = 8000,
            cargo_door_7 = 8032,
            cargo_door_8 = 8064,
            cargo_door_9 = 8096,
            cargo_door_10 = 8128,
            centre_refuelling_drogue = 8160,
            port_refuelling_drogue = 8192,
            starboard_refuelling_drogue = 8224,
            submarine_engine_exhaust_mast = 8256,
            submarine_mast_1 = 8288,
            submarine_mast_2 = 8320,
            submarine_mast_3 = 8352,
            submarine_mast_4 = 8384,
            submarine_mast_5 = 8416,
            submarine_mast_6 = 8448,
            submarine_mast_7 = 8480,
            submarine_mast_8 = 8512,
            submarine_mast_9 = 8544,
            submarine_mast_10 = 8576,
            vectored_thrust_nozzle = 8608,
            left_door_of_the_left_weapon_bay = 8640,
            right_door_of_the_left_weapon_bay = 8672,
            left_door_of_the_right_weapon_bay = 8704,
            right_door_of_the_right_weapon_bay = 8736,
            gun_door = 8768,
            countermeasure_door_left = 8800,
            countermeasure_door_right = 8832,
            hook_door_forward = 8864,
            hook_door_aft = 8896,
            lift_fan_upper_door = 8928,
            lift_fan_lower_door_left = 8960,
            lift_fan_lower_door_right = 8992,
            refuel_probe_door = 9024,
            left_engine_nacelle = 9056,
            right_engine_nacelle = 9088,
            first_left_wheel = 9120, // wheels
            first_right_wheel = 9152,
            second_left_wheel = 9184,
            second_right_wheel = 9216,
            third_left_wheel = 9248,
            third_right_wheel = 9280,
            fourth_left_wheel = 9312,
            fourth_right_wheel = 9344,
            fifth_left_wheel = 9376,
            fifth_right_wheel = 9408,
            sixth_left_wheel = 9440,
            sixth_right_wheel = 9472,
            seventh_left_wheel = 9504,
            seventh_right_wheel = 9536,
            eighth_left_wheel = 9568,
            eighth_right_wheel = 9600,
            ninth_left_wheel = 9632,
            ninth_right_wheel = 9664,
            tenth_left_wheel = 9696,
            tenth_right_wheel = 9728,  // 304 X 32
            refueling_probe = 9760,
            steering_wheel = 9792,
            gimabled_sensor_azimuth_1 = 15424, // match VRF parts
            gimabled_sensor_azimuth_2 = 15456,
            gimabled_sensor_azimuth_3 = 15488,
            gimabled_sensor_azimuth_4 = 15520,
            gimabled_sensor_azimuth_5 = 15552,
            gimabled_sensor_azimuth_6 = 15584,
            gimabled_sensor_azimuth_7 = 15616,
            gimabled_sensor_azimuth_8 = 15648,
            gimabled_sensor_azimuth_9 = 15680,
            gimabled_sensor_azimuth_10 = 15712,
            gimabled_sensor_elevation_1 = 15744,  // match VRF parts
            gimabled_sensor_elevation_2 = 15776,
            gimabled_sensor_elevation_3 = 15808,
            gimabled_sensor_elevation_4 = 15840,
            gimabled_sensor_elevation_5 = 15872,
            gimabled_sensor_elevation_6 = 15904,
            gimabled_sensor_elevation_7 = 15936,
            gimabled_sensor_elevation_8 = 15968,
            gimabled_sensor_elevation_9 = 16000,
            gimabled_sensor_elevation_10 = 16032,
            // 
            // For MAK extensions, start at the opposite end and work backwards
            // largest value in 32 bit field that is a multiple of 32 is 134,217,727? X 32 =  4,294,967,264?
            // However, we don't really need *that* many, and since the risk of someone not using *unsigned*
            // or *short* (or both) somewhere along the pipeline is real, lets used max signed short instead
            //
            wind_blades = 32736,     // 1023 X 32  parts that  rotate into the wind direction
            wind_direction = 32704   // 1022 X 32  parts that rotate based on wind speed, like turbine blades
         };
      };


      static DtModelSemanticsMapper& instance(DtDe&);

      virtual DtModelSemanticsMapper* clone();

      static void copyInstance( DtBaseConnection& con, DtDe& de);

      static DtModelSemanticsMapper& instance( DtBaseConnection& con );

      virtual ~DtModelSemanticsMapper();

      const std::string* findStateName(States::Id id) const;

      const States::Id* findStateId(const std::string& name) const;

      const std::string* findPartName(Parts::Id id) const;

      const Parts::Id* findPartId(const std::string& name) const;

      void addState(const std::string& name, States::Id id);

      void removeState(const std::string& name);

      void addPart(const std::string& name, Parts::Id id);

      void removePart( const std::string& name);

   protected:

      virtual std::string cleanUpName(const std::string&) const;

      virtual bool partNameIsNumber(const std::string& partName) const;

      DtModelSemanticsMapper();

      virtual void initialize();

      typedef std::map<std::string,States::Id> StateNameToIdMap;
      typedef std::map<States::Id,std::string> StateIdToNameMap;

      typedef std::map<std::string,Parts::Id> PartNameToIdMap;
      typedef std::map<Parts::Id,std::string> PartIdToNameMap;

      StateNameToIdMap myStateNamesToIds;
      StateIdToNameMap myStateIdsToNames;

      PartNameToIdMap myPartNamesToIds;
      PartIdToNameMap myPartIdsToNames;
   };

   class DT_DLL_VRVCORE DtModelSemanticsMapperCreator : public DtVirtualBaseClass
   {
   public:

      static void registerInstance(DtDe& de,DtModelSemanticsMapperCreator*);


      static DtModelSemanticsMapperCreator& instance(DtDe& de);      

      DtModelSemanticsMapperCreator();

      virtual ~DtModelSemanticsMapperCreator();

      virtual DtModelSemanticsMapper* create(); 

   };

} 
 
#endif