Navigator

From SIMboxWiki
Jump to navigation Jump to search

The Navigator logic component handles how the aircraft moves through the waypoints. Forward, backward and status of way points.

Type: Logic Object Component
File: Navigator.slc
Version: 450.1000.342.1


back to top

Icon properties.png Properties

NameDescriptionMaxValueMinValueDisplayNameUnitTypeUnitName
PROP_CHANGE_TO_NEXT_WAYPOINT_RANGE_NM  Distance from current waypoint for switching to next one  100    Default  Default 
PROP_DEFAULT_INS_STATUS  Default status of the INS system [OFF,NORM,NAV,CAL,ATT,STOR_HDG]  INS Status  Default  Default 
PROP_DEFAULT_WAYPOINT_CHANGE_MODE  Default waypoint changing mode Manual/Auto  Waypoint Rotation Mode  Default  Default 
PROP_DEFAULT_WAYPOINT_SPEED  The default waypoint speed  1000    Default  Default 
PROP_DEFAULT_WAYPOINT_TURN_RADIUS  The default waypoint turn raduis  100000    Default  Default 
PROP_MINIMAL_NUMBER_OF_WAYPOINTS  Total number of waypoints in system  101    Default  Default 
PROP_NAVIGATION_VELOCITY_KNOTS  The velocity that the WP estimated arrival time is calc with.    Speed  Knots 
PROP_NAVIGATOR_IS_REACHED_POINT_2D  if true - checks if reached point only on the horizontal plane    Default  Default 
PROP_NAVIGATOR_MARK_MAX_WAYPOINT_NUMBER  The max waypoint number for the MARK WP id  100    Default  Default 
PROP_NAVIGATOR_MARK_MIN_WAYPOINT_NUMBER  The min waypoint number for the MARK WP id  100    Default  Default 
PROP_NAVIGATOR_ROUTE_NAME  The name of the route attached to the entity  Route  Entity Identifier  Entity Name 
PROP_WAYPOINT_DEFAULT_IMPACT_ANGLE  Default impact angle for waypoints  Waypoint Impact Angle  Angle  Degree 
PROP_WAYPOINT_IS_TO_INIT_TIME_OVER_FIRST_WAYPOINT_WHEN_I_CROSS_OVER  Is to recalculate estimated WP arrival time when I cross over the first WP (Add sim time to the current values)    Default  Default 
PROP_WAYPOINT_PATH_STARTS_FROM_ENTITY  If the waypoint must start from the entity, waypoint zero will be set to entity position    Default  Default 
PROP_WAYPOINT_TIME_OVER_FIRST_WAYPOINT  The estimated WP arrival time will take that value as starting seconds - wp1 time.    Default  Default 

back to top

Icon attributes.png Attributes

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ATT_ASPECT_TO_CURRENT_WAYPOINT  Get the aspect between me and the current waypoint  float &    Aspect to current waypoint  Default  Default 
ATT_AZIMUTH_TO_CURRENT_WAYPOINT  Get Azimuth current waypoint [deg]  float &    Azimuth to current waypoint  Default  Default 
ATT_CURRENT_IDENTIFICATION_WAYPOINT_TOS  Current identification waypoint time over steerpoint  float &      Default  Default 
ATT_CURRENT_IWP_ENTITY_ID  Current Identification point iwp entity ID  int &      Default  Default 
ATT_CURRENT_LEG_ESTIMATED_TIME_SECONDS  The current leg estimated time in seconds - from Scenario Editor  int &      Default  Default 
ATT_CURRENT_LEG_START_TIME  Sim time we started navigate this leg  float &      Default  Default 
ATT_CURRENT_VIEW_INTEREST_ENTITY_ID  ID Name of interesting entity in this leg  int &      Default  Default 
ATT_CURRENT_WAYPOINT  Current waypoint position  LinearVec &    Current waypoint position  Coordinate System  Local 
ATT_CURRENT_WAYPOINT_ALT  Current waypoint altitude [ft]  float &      Length  Feet 
ATT_CURRENT_WAYPOINT_BALL_DEVIATION  The ball deviation on current waypoint  AngularVec &      Default  Default 
ATT_CURRENT_WAYPOINT_COMPASS_DEVIATION  The compass deviation on current waypoint  float &      Default  Default 
ATT_CURRENT_WAYPOINT_DEVIATION_DISTANCE_FROM_PATH  The deviation distance from wp path - negative for left deviation, positive for right deviation  float &      Default  Default 
ATT_CURRENT_WAYPOINT_ENTITY_ID  Current waypoint entity ID  int &      Default  Default 
ATT_CURRENT_WAYPOINT_HEADING_ANG_DEG  The heading angle for the waypoint [Deg]  float &    Current Waypoint Impact Heading   Default  Default 
ATT_CURRENT_WAYPOINT_ID  Current waypoint ID  int &    Current waypoint ID  Default  Default 
ATT_CURRENT_WAYPOINT_IMPACT_ANG_DEG  The impact angle for the waypoint [Deg]  float &    Current Waypoint Impact Angle  Default  Default 
ATT_CURRENT_WAYPOINT_LAT  Current waypoint Latitude [deg]  float &      Angle  Degree 
ATT_CURRENT_WAYPOINT_LONG  Current waypoint Longitude [deg]  float &      Angle  Degree 
ATT_CURRENT_WAYPOINT_NAME  Current waypoint name  string &      Default  Default 
ATT_CURRENT_WAYPOINT_REACH_HEADING  The heading to approach the next waypoint (-1.0=auto)  float &      Default  Default 
ATT_CURRENT_WAYPOINT_SPEED_FOR_TOS_STR  Necessary speed for arriving at waypoint at TOS (knots) string  string &      Default  Default 
ATT_CURRENT_WAYPOINT_STAGE_ID  Current waypoint stage ID  int &    Current waypoint Stage ID  Default  Default 
ATT_CURRENT_WAYPOINT_STAGE_NAME  The waypoint Stage (Navigate, Holding)  string &      Default  Default 
ATT_CURRENT_WAYPOINT_STATUS  The waypoint status (IN, OUT or NEW)  string &    Current waypoint Status  Default  Default 
ATT_CURRENT_WAYPOINT_TOS  Current waypoint time over steerpoint  float &      Default  Default 
ATT_CURRENT_WAYPOINT_WIND_DIRECTION  The wind direction on current waypoint  float &      Default  Default 
ATT_CURRENT_WAYPOINT_WIND_SPEED  The wind speed on current waypoint  float &      Default  Default 
ATT_DISPLAYED_WAYPOINT_ALT  UFC Displayed waypoint altitude [ft]  float &    Displayed waypoint Altitude  Default  Default 
ATT_DISPLAYED_WAYPOINT_HEADING_ANG_DEG  UFC Displayed waypoint heading angle [Deg]  float &    Displayed waypoint Impact heading  Default  Default 
ATT_DISPLAYED_WAYPOINT_ID  UFC Displayed waypoint ID  int &    Displayed waypoint ID  Default  Default 
ATT_DISPLAYED_WAYPOINT_IMPACT_ANG_DEG  UFC Displayed waypoint impact angle [Deg]  float &    Displayed waypoint Impact angle  Default  Default 
ATT_DISPLAYED_WAYPOINT_LAT  UFC Displayed waypoint Latitude [deg]  float &    Displayed waypoint Latitude  Default  Default 
ATT_DISPLAYED_WAYPOINT_LONG  UFC Displayed waypoint Longitude [deg]  float &      Default  Default 
ATT_DISPLAYED_WAYPOINT_NAME  UFC Displayed waypoint name  string &    Displayed waypoint Name  Default  Default 
ATT_DISPLAYED_WAYPOINT_STATUS  The status of the current displayed waypoint on the DED  string &      Default  Default 
ATT_DISPLAYED_WAYPOINT_TOS  UFC Displayed waypoint time over steerpoint  float &    Displayed waypoint TOS  Default  Default 
ATT_DISTANCE_TO_CURRENT_WAYPOINT  Get the distance between me and the current waypoint  float &      Default  Default 
ATT_ELEVATION_TO_CURRENT_WAYPOINT  Get heading current waypoint [deg]  float &      Default  Default 
ATT_GET_TIME_2_NEXT_WP_BY_ID  The arrival time to specific waypoint  const int  int &    Time  Seconds 
ATT_GET_WAYPOINT_BY_ID  Get the waypoint according to its Id  const int  LinearVec &    Default  Default 
ATT_GET_WAYPOINT_BY_NAME  Get the waypoint according to its name  const string &  LinearVec &  Get waypoint by Name  Default  Default 
ATT_GET_WAYPOINT_ESTIMATED_ARRIVAL_TIME_BY_ID  Estimated waypoint arrival time  const int  double &    Default  Default 
ATT_GET_WAYPOINT_HEADING_ANGLE_BY_ID  The waypoint hit angle by waypoint id  const int  float &    Angle  Degree 
ATT_GET_WAYPOINT_HEIGHT_BY_ID  The waypoint height by waypoint id  const int  float &  Get waypoint HEIGHT by ID  Length  Feet 
ATT_GET_WAYPOINT_IMPACT_ANGLE_BY_ID  The waypoint hit angle by waypoint id  const int  float &    Angle  Degree 
ATT_GET_WAYPOINT_LAT_BY_ID  The waypoint lat by waypoint id  const int  double &  Get waypoint LATITUDE by ID  Angle  Degree 
ATT_GET_WAYPOINT_LONG_BY_ID  The waypoint long by waypoint id  const int  double &  Get waypoint LONGITUDE by ID  Angle  Degree 
ATT_GET_WAYPOINT_NAME_BY_ID  Waypoint Name  const int  string &  Get waypoint name by ID  Default  Default 
ATT_GET_WAYPOINT_SPEED_ID  The speed to set at the waypoint by waypoint id  const int  float &    Default  Default 
ATT_GET_WAYPOINT_STAGE_BY_ID  Waypoint Stages by Waypoint ID  const int  int &  Get waypoint Stage by ID  Default  Default 
ATT_GET_WAYPOINT_STATUS_BY_ID  The waypoint status (IN, OUT or NEW) by waypoint ID  const int  string &    Default  Default 
ATT_GET_WAYPOINT_WIND_DIRECTION_BY_ID  The wind direction when flying to specific waypoint  const int  float &    Angle  Degree 
ATT_GET_WAYPOINT_WIND_SPEED_BY_ID  The wind speed when flying to specific waypoint  const int  float &    Speed  Kilometer Per Hour 
ATT_INS_STATUS  The INS navigation system status. Can be OFF, STOR_HDG, NORM, NAV, CAL or ATT  string &    INS status  Default  Default 
ATT_IWP_DEVIATION_FROM_LAST_WP  The deviation from last wp  float &      Default  Default 
ATT_IWP_DEVIATION_TO_NEXT_WP  The deviation to next wp  float &      Default  Default 
ATT_IWP_IS_PASSSED_OVER  Is passed over the current Identification waypoint?  bool &      Default  Default 
ATT_IWP_TIME_DEVIATION_FROM_ESTIMATED_TIME  The time difference from expected IWP time to actual leg time. 5 = delay of 5 seconds, -5 = faster in 5 seconds  float &      Default  Default 
ATT_MIN_DISTANCE_FROM_LAST_WAYPOINT  Minimum distance from last waypoint - for debrief perpuse  float &      Default  Default 
ATT_NAVIGATOR_ALT_OFFSET  The altitude offset to add to each waypoint  float &      Default  Default 
ATT_NAVIGATOR_CURRENT_CHECKED_WAYPOINT  The waypoint number currently checked  int &      Default  Default 
ATT_NAVIGATOR_CURRENT_MARK_TYPE  Current mark type can be OFLY, FCR, HUD or TGP  string &      Default  Default 
ATT_NAVIGATOR_CURRENT_MARK_WAYPOINT_ID  The current mark waypoint to be fill when entering to MARK page on the DED  int &      Default  Default 
ATT_NAVIGATOR_CURRENT_ROUTE_DISPLAY_NAME  Display name of the current executed route  string &      Default  Default 
ATT_NAVIGATOR_CURRENT_ROUTE_ENTITY_ID  Display name of the current executed route  int &      Default  Default 
ATT_NAVIGATOR_CURRENT_ROUTE_ENTITY_NAME  Entity name of the current executed route  string &      Default  Default 
ATT_NAVIGATOR_CURRENT_WAYPOINT_DISPLAY_NAME  Current waypoint display name  string &      Default  Default 
ATT_NAVIGATOR_IS_2D_MODE  Is the distance to waypoint is 2D distance?  bool &      Default  Default 
ATT_NAVIGATOR_RANGE_FOR_IMPACT_ANGLE  If we are closer to the next waypoint, we fly at the defined impact angle  const int  float &    Default  Default 
ATT_NAVIGATOR_VELOCITY_OVERRIDE  The velocity override for the route (replaces waypoint velocity param)  float &      Default  Default 
ATT_NUMBER_OF_WAYPOINTS  Get the number of waypoints  int &      Default  Default 
ATT_PREVIOUS_LEG_TIME_DEVIATION_FROM_ESTIMATED_TIME  The time difference from expected leg time to actual leg time. 5 = delay of 5 seconds, -5 = faster in 5 seconds  float &      Default  Default 
ATT_PREVIOUS_WAYPOINT  Get the previous waypoint  LinearVec &      Coordinate System  Local 
ATT_RANGE_ON_GROUND_TO_WAYPOINT  Get the range to the current waypoint in miles  float &      Default  Default 
ATT_SPEED_TO_CURRENT_WAYPOINT  Get the speed it takes to the current waypoint  int &      Default  Default 
ATT_TIME_ON_GROUND_TO_CURRENT_WAYPOINT  Get the time it takes to reach on ground to the current waypoint  float &      Default  Default 
ATT_TIME_TO_CURRENT_WAYPOINT  Get the time it takes to the current waypoint  float &      Default  Default 
ATT_TIME_TO_REACH_CURRENT_WAYPOINT  the time to reach the current waypoint  float &      Time  Seconds 
ATT_TOTAL_NUMBER_OF_WAYPOINTS  Total number of waypoints (including uninitialized ones  int &      Default  Default 
ATT_WAYPOINTS_IS_AUTO_MODE  Is the Waypoint mode auto - waypoints change automatically?  bool &      Default  Default 
ATT_WAYPOINTS_IS_CALC_SPEED  Is the Waypoint mode calc speed for arriving at TOS for current waypoint?  bool &      Default  Default 

back to top

Icon actions.png Actions

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ACTION_BACKWARD_WAYPOINT  Backward to previous waypoint        Default  Default 
ACTION_CALC_NUM_OF_WAYPOINTS  Calculates number of waypoints        Default  Default 
ACTION_FORWARD_WAYPOINT  Forward to next waypoint        Default  Default 
ACTION_NAVIGATOR_SET_WAYPOINT_SPEED_BY_ID  Sets the travel speed to set when arriving at this waypoint (m/s)  const int  const float    Default  Default 
ACTION_NEXT_DISPLAYED_WAYPOINT  Display next waypoint        Default  Default 
ACTION_PREVIOUS_DISPLAYED_WAYPOINT  Display previous waypoint        Default  Default 
ACTION_REFRESH_CURRENT_WAYPOINT  Refresh the current waypoint for example: when the sequencer changes sequences)        Default  Default 
ACTION_SET_2D_MODE  true - Set distance calculation to 2D mode, false - 3D  const bool      Default  Default 
ACTION_SET_CURRENT_CHECKED_WAYPOINT_NUMBER  Set the current checked waypoint number  const int      Default  Default 
ACTION_SET_CURRENT_ROUTE_ENTITY_ID  Sets the current route id to fly by its entity id  const int      Entity Identifier  Entity ID 
ACTION_SET_CURRENT_ROUTE_NAME  Sets the current route to fly by its entity id  const string &      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_ALTITUDE  Change the UFC displayed TOS  const float      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_LATITUDE  Change the UFC displayed latitude  const float      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_LONGITUDE  Change the UFC displayed longitude  const float      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_NUMBER  Set the current waypoint number  const int      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_STATUS  Set current waypoint status (IN, OUT or NEW  const string &      Default  Default 
ACTION_SET_CURRENT_WAYPOINT_TOS  Change the UFC displayed TOS  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_ALTITUDE  Change the UFC displayed TOS  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_HEADING_ANG_DEG  Change the UFC displayed heading angle [Deg]  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_IMPACT_ANG_DEG  Change the UFC displayed impact angle [Deg]  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_LATITUDE  Change the UFC displayed latitude  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_LONGITUDE  Change the UFC displayed longitude  const float      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_NUMBER  Change the UFC displayed waypoint  const int      Default  Default 
ACTION_SET_DISPLAYED_WAYPOINT_TOS  Change the UFC displayed TOS  const float      Default  Default 
ACTION_SET_NAVIGATOR_ALT_OFFSET  Sets the altitude offset to add to each waypoint  const float      Default  Default 
ACTION_SET_NAVIGATOR_VELOCITY_OVERRIDE  Sets the velocity override for the route (replaces waypoint velocity param)  const float      Default  Default 
ACTION_SET_NEAREST_WAYPOINTS  set the mode of handling the waypoints (manual/auto)        Default  Default 
ACTION_SET_WAYPOINT_ALTITUDE  Set waypoint number # 's altitude  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_ALTITUDE_BY_ID  Set waypoint number # 's altitude  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_HEADING_ANG_BY_ID  Set waypoint heading angle [deg] by ID  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_IMPACT_ANG_BY_ID  Set waypoint impact angle [deg] by ID  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_IMPACT_RANGE  Sets the range to start climb/descent in the defined impact angle [NM]  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_LAT_BY_ID  Set waypoint Latitude [deg] by ID  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_LONG_ANG_BY_ID  Set waypoint Longitude [deg] by ID  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_NAME  Set waypoint number # 's name  const int  const string &    Default  Default 
ACTION_SET_WAYPOINT_NAME_BY_ID  Set waypoint number # 's name  const int  const string &    Default  Default 
ACTION_SET_WAYPOINT_STATUS_BY_ID  Set a waypoint status (IN, OUT or NEW  const int  const string &    Default  Default 
ACTION_SET_WAYPOINT_TOS  Set waypoint number # TOS to requested value  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_TOS_BY_ID  Set waypoint number # TOS to requested value  const int  const float    Default  Default 
ACTION_SET_WAYPOINT_VALUE  Set waypoint number # to requested value  const int  const LinearVec &    Default  Default 
ACTION_SET_WAYPOINT_VALUE_BY_ID  Set waypoint number # to requested value  const int  const LinearVec &    Default  Default 
ACTION_SET_WAYPOINTS_MODE  Set the mode of handling the waypoints (manual/auto)  const int      Default  Default 
ACTION_SWITCH_TO_SEQUENCE_MODE  Switch navigator to work with sequencer  const bool      Default  Default 
ACTION_TOGGLE_CURRENT_WAYPOINT_STATUS  Toggles the displayed waypoint status        Default  Default 
ACTION_TOGGLE_DISPLAYED_WAYPOINT_STATUS  Toggles the displayed waypoint status        Default  Default 
ACTION_TOGGLE_MARK_TYPE  Toggles current mark type. Can be OFLY, FCR, HUD, TGP        Default  Default 
ACTION_TOGGLE_MARK_WAYPOINT_ID  Toggles the current mark waypoint ID to the next in turn        Default  Default 
ACTION_TOGGLE_WAYPOINTS_CALC_SPEED  Toggle the mode of calculating speed for current waypoint to arrive at TOS        Default  Default 
ACTION_TOGGLE_WAYPOINTS_MODE  Toggle the mode of handling the waypoints (manual/auto)        Default  Default 
DECREASE_CHECKED_WAYPOINT  Decrease the number of the checked waypoint  const int  const int    Default  Default 
INCREASE_CHECKED_WAYPOINT  Increase the number of the checked waypoint  const int  const int    Default  Default 
NAVIGATOR_BACKWARD_WAYPOINT  Waypoint - Previous  const int  const int    Default  Default 
NAVIGATOR_FORWARD_WAYPOINT  Waypoint - Next  const int  const int    Default  Default 
NAVIGATOR_SET_MODE  Navigation - waypoints change (manual / auto)  const int  const int    Default  Default 
TOGGLE_INS_STATUS  Toggle the INS status  const int  const int    Default  Default 

back to top

Icon attributes.png Required Attributes

Name
ATT_ANGLE_TO_CURRENT_WAYPOINT 
ATT_CURRENT_SOI 
ATT_GROUP_BOTTOM_ENTITY_ID 
ATT_ICAO_SELECTED_LAT 
ATT_ICAO_SELECTED_LON 
ATT_INDICATED_AIRSPEED 
ATT_ROUTE_ITER_NEXT_WP 
ATT_ROUTE_WAYPOINT_ITERATOR 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT_ELEVATIONS 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT_IDS 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT_LATITUDE 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT_LONGITUDE 
ATT_SEQUENCER_CURRENT_NAVIGATED_WAYPOINT_NAMES 
ATT_TRUE_HEADING 
ATT_TYPE_NAME 

back to top

Icon actions.png Required Actions

Name
ACTION_ICAO_SELECT_ICAO_TO_SHOW_DATA 
ACTION_MANEUVER_LEVEL_FLIGHT_PUT_NEXT_VALUES_IN_STBY 
ACTION_MANEUVER_LEVEL_FLIGHT_SET_ALTITUDE 
ACTION_MANEUVER_LEVEL_FLIGHT_SET_HDG 
ACTION_MANEUVER_LEVEL_FLIGHT_SET_SPEED 
ACTION_SEQUENCER_NAVIGATED_SET_NEXT_WAYPOINT 
ACTION_SEQUENCER_NAVIGATED_SET_PREVIOUS_WAYPOINT 
ACTION_SET_ACTIVE_MANUEVER_NAME 
ACTION_SET_NAME 
ACTION_SET_SPI 

back to top,