SMG GenericBrainUtils

From SIMboxWiki
Jump to navigation Jump to search

The GenericBrainUtils logic component handles all the generic brain utils that are common to all entities.

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


back to top

Icon properties.png Properties

NameDescriptionMaxValueMinValueDisplayNameUnitTypeUnitName
PROP_BOOKMARK_ENTITY_BASE_OBJECT_TYPE  Bookmark entity base object type    Default  Default 
PROP_GOTO_BRAIN_NAME  The name of the agent used for the Go To Location action    Default  Default 
PROP_TIME_BETWEEN_PATH_POINTS  Time between points in aircraft path [Seconds]  999999    Default  Default 
PROP_TIME_TO_TAXI  Minimum time to start taxi [Seconds]  999999  Time Delay to Taxi  Default  Default 
PROP_UPDATE_ENTITY_PATH_POINTS  If to updaet ATT_ENTITY_PATH_POINTS.    Default  Default 
PROP_USER_INPUTS_TO_TRACK  User input to track (<user input>|<bitmap>|<description>|)    Default  Default 

back to top

Icon attributes.png Attributes

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ATT_ACTIVE_CAMERA_NAME  Return active camera name  string &      Default  Default 
ATT_AI_ROUNDED_AIRSPEED  Round the airspeed value to the requested rounding  const int  int &    Default  Default 
ATT_AI_ROUNDED_ALTITUDE  Round the altitude value to the requested rounding  const int  int &    Default  Default 
ATT_AI_SUBPART_ANG_FLAPS_DEG  The angle of the flaps subpart in degrees  int &      Angle  Degree 
ATT_AI_VELOCITY_VECTOR  The pitch angle of the velocity vector (the bird angle)  int &      Angle  Degree 
ATT_AI_VERTICAL_VELOCITY_FEET_PER_MINUTE  The entity vertical velocity in feet per minute  float &      Default  Default 
ATT_BOOKMARK_ENTITY_BASE_OBJECT_TYPE  Bookmark entity base object type  string &      Default  Default 
ATT_CLOSURE_VELOCITY_KNOTS  Return closure velocity betweeen meand the given entity  const int  float &    Speed  Knots 
ATT_CONVERGING_SPEED_TO_REFERENCE_LINE  The closure speed to the line. Positive if converging.  float &      Speed  Meter Per Second 
ATT_CURRENT_RELATIVE_ENTITY  Current relative entity.  int &      Entity Identifier  Entity ID 
ATT_CURRENT_RELATIVE_ENTITY_NAME  Current relative entity name.  string &      Entity Identifier  Entity Name 
ATT_CURRENT_TRAINEE_GRADE  Trainee profile grade of the current subject  int &      Default  Default 
ATT_DISTANCE_FROM_PICK_POINT_TO_LAST_CREATED_ENTITY  Distance from Focal Point to user mouse pick on the terrain [Meter]  float &      Length  Meter 
ATT_ENTITY_BRAIN_STATUS  Set entity agent status.  const string &  string &    Default  Default 
ATT_ENTITY_DYNAMIC_DATA  Set/transfer variables between brains in the same entity. Set dynamic data title and value  const string &  string &    Default  Default 
ATT_ENTITY_PATH_POINTS  Entity path points  string &      Default  Default 
ATT_FOCUSED_ENTITY  Focused entity ID  int &      Default  Default 
ATT_FOCUSED_ENTITY_NAME  Focused entity name  string &      Default  Default 
ATT_GET_AIRPORT_ROUTE_WP_FOR_QUERY  The name of the wp in the airport route for query  string &      Default  Default 
ATT_GET_AIRPORT_ROUTE_WP_FOR_QUERY_POS  The position of the wp in the airport route for query  LinearVec &      Default  Default 
ATT_GET_ANGLE_TO_RUNWAY_GLIDE_SLOPE_POWER_100  Return angle (Deg) from the runway glide slope - power by 100. 3 degree - return 300  float &      Angle  Degree 
ATT_GET_ANGLE_TO_RUNWAY_TRACK  Return angle (Deg) from the runway track  float &      Angle  Degree 
ATT_GET_AZIMUTH_BETWEEN_ENTITIES  Return azimuth (Deg) between this entity to other  const int  float &    Angle  Degree 
ATT_GET_DISTANCE_FOR_AIRPORT_ROUTE_WP  Return distance (Meters) from the airport route waypoint that set for query  float &      Length  Meter 
ATT_GET_DISTANCE_FROM_ENTITY_METERS  Return the distance (Meters) from the owner aircraft to the entity  const int  float &    Length  Meter 
ATT_GET_DISTANCE_FROM_ENTITY_MILES  Return the distance (NM) from the owner aircraft to the entity  const int  float &    Length  Nautical Mile 
ATT_GET_DISTANCE_FROM_REFERENCE_POINT2_ARC  The required time to reach point 2 in a straight line at the current flight speed  float &      Time  Seconds 
ATT_GET_ELEVATION_BETWEEN_ENTITIES  Return elevation (Deg) between this entity to other  const int  float &    Angle  Degree 
ATT_GET_GROUND_DISTANCE_FROM_POINT1_MILES  Get groung distance from reference line point 1  float &      Length  Mile 
ATT_GET_GROUND_DISTANCE_FROM_POINT2_MILES  Get groung distance from reference line point 2  float &      Length  Mile 
ATT_GET_GROUND_DISTANCE_FROM_REFERENCE_LINE_METERS  Get distance from reference line in meters  float &      Length  Meter 
ATT_GET_GROUND_DISTANCE_FROM_REFERENCE_LINE_MILES  Get distance from reference line in miles  float &      Length  Mile 
ATT_GET_HEADING_FROM_POINT1  The heading from reference line point 1  float &      Angle  Degree 
ATT_GET_HEADING_FROM_POINT2  The heading from reference line point 2  float &      Angle  Degree 
ATT_GET_IS_LEFT_OF_REFERENCE_LINE  Is aircraft need to turn right to fly to point2?  bool &      Default  Default 
ATT_GET_MINIMAL_TIME_TO_REACH_POINT2  The required time to reach point 2 in a straight line at the current flight speed  float &      Time  Seconds 
ATT_GET_ONLINE_OPEN_QUESTION_ANSWER_BY_INDEX  Get online open question answer by index  const int  string &    Default  Default 
ATT_GET_RADIAL_VELOCITY_FROM_REFERENCE_POINT2  The required time to reach point 2 in a straight line at the current flight speed  float &      Time  Seconds 
ATT_GET_REFERENCE_LINE_HEADING  Get Reference Line Heading from point 1 to point 2  float &      Angle  Degree 
ATT_GET_REFERENCE_LINE_LENGTH_MILE  Get Reference Line Lenght  float &      Length  Mile 
ATT_GET_RELATIVE_HEADING_FROM_POINT1  The required heading change ro point at reference point 1  float &      Angle  Degree 
ATT_GET_RELATIVE_HEADING_FROM_POINT2  The required heading change ro point at reference point 2  float &      Angle  Degree 
ATT_GET_RELATIVE_HEADING_FROM_REFERENCE_LINE  Get relative heading from reference line  float &      Angle  Degree 
ATT_GET_RELATIVE_HEIGHT_FROM_POINT1_FEET  Relative Height from point 1  float &      Length  Feet 
ATT_GET_RELATIVE_HEIGHT_FROM_POINT2_FEET  Relative Height from point 2  float &      Length  Feet 
ATT_GET_RELATIVE_HEIGHT_FROM_REFERENCE_LINE_FEET  Get relative height from line   float &      Length  Feet 
ATT_GET_REQUIRED_HEADING_TO_POINT2  Is reference line Point2 behind me?  float &      Default  Default 
ATT_GET_REQUIRED_SPEED_TO_POINT2  Is reference line Point2 behind me?  float &      Default  Default 
ATT_GET_TIME_TO_REACH_ENTITY  Returns the time to reach the entity  const int  float &    Time  Seconds 
ATT_GOTO_BRAIN_NAME  The name of the agent used for the Go To Location action  string &      Default  Default 
ATT_GOTO_BRAIN_NEXT_POSITION  The position the next loaded goto agent needs to go to  LinearVec &      Default  Default 
ATT_HEIGHT_OFFSET_FROM_CHECK_POINT  Height offset from the last check point set by action 'ACTION_SET_CURRENT_HEIGHT_CHECK_POINT'  float &      Length  Feet 
ATT_IS_ENTITY_EXISTS  Checks if given entity name exists in simulation. Returns: 1-Exists, 0-Not Exists.  const string &  int &    Default  Default 
ATT_IS_GROUND_DISTANCE_CONVERGING_TO_REFERENCE_LINE  Is aircraft ground distance converging to reference line  bool &      Default  Default 
ATT_IS_HEIGHT_CONVERGING_TO_POINT2  Is aircraft height converging to point 2  bool &      Default  Default 
ATT_IS_INSTRUCTOR_AIRCRAFT_FLYING  Is instructor aircraft flying  bool &      Default  Default 
ATT_IS_LOOKING_AT_FOCAL_POINT  Check if trainee is looking on the Focal Point  bool &      Default  Default 
ATT_IS_PASSED_REFERENCE_LINE_POINT1  Is reference line Point1 behind me?  bool &      Default  Default 
ATT_IS_PASSED_REFERENCE_LINE_POINT2  Is reference line Point2 behind me?  bool &      Default  Default 
ATT_IS_SYSTEM_DISPLAYED  Return is system displayed  bool &      Default  Default 
ATT_IS_VI_KEY_PRESSED  Service attribute - Is key was pressed for the VI  bool &      Default  Default 
ATT_LAST_MOUSE_OVER_FOCAL_POINT  Last mouse over focal point  string &      Default  Default 
ATT_LAST_PICKED_FOCAL_POINT  Last picked focal point  string &      Default  Default 
ATT_LAST_PICKED_MOUSE_REGION  Last picked mouse resion  string &      Default  Default 
ATT_MFD_BOTTOM_DISPLAY_PAGE  Returns the displayed system of the bottom MFD  string &      Default  Default 
ATT_MFD_L_DISPLAY_PAGE  Returns the displayed system of the left MFD  string &      Default  Default 
ATT_MFD_R_DISPLAY_PAGE  Returns the displayed system of the right MFD  string &      Default  Default 
ATT_NUMBER_OF_MONITORS  Number of frames the simulation opens  int &      Default  Default 
ATT_NUMBER_OF_OPENED_WINDOWS  Number of opened window  int &      Default  Default 
ATT_ONLINE_DIALOG_ANSWER  Answer from online question dialog  int &      Default  Default 
ATT_PITCH_ANGLE_DEG  The aircaft pitch angle [Deg]  float &      Angle  Degree 
ATT_RANDOM  Value between 0 to 100  int &      Default  Default 
ATT_REFERENCE_POINT1_POSITION  The position of point 1  LinearVec &      Default  Default 
ATT_REFERENCE_POINT2_POSITION  The position of Point 2  LinearVec &      Default  Default 
ATT_ROLL_ANGLE_DEG    float &      Angle  Degree 
ATT_TIME_COUNTER_1  Return value of time counter #1  float &      Default  Default 
ATT_TIME_COUNTER_2  Return value of time counter #2  float &      Default  Default 
ATT_TIME_COUNTER_3  Return value of time counter #3  float &      Default  Default 
ATT_TIME_TO_TAXI  Minimum time to start taxi [Seconds]  int &      Time  Seconds 

back to top

Icon actions.png Actions

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ACTION_CLOSE_LAST_CREATED_WINDOW  Close last created window        Default  Default 
ACTION_CLOSE_WINDOW_BY_NAME  Close window by name  const string &      Default  Default 
ACTION_CREATE_BOOKMARK_BY_ENTITY_ID  Create bookmark by entity id  const string &  const int    Default  Default 
ACTION_CREATE_BOOKMARK_BY_ENTITY_NAME  Create bookmark by entity name  const string &  const string &    Default  Default 
ACTION_CREATE_BOOKMARK_BY_POSITION  Create bookmark by position  const string &  const LinearVec &    Default  Default 
ACTION_DELETE_ALL_ONLINE_OPEN_QUESTION_ANSWERS  Delete all answers        Default  Default 
ACTION_DELETE_ONLINE_OPEN_QUESTION_ANSWER_BY_INDEX  Delete answer by index  const int      Default  Default 
ACTION_RESET_DISTANCE_FROM_PICK_POINT_TO_LAST_CREATED_ENTITY  Reset the distance from Focal Point to user mouse pick on the terrain [set to -1]        Default  Default 
ACTION_RESET_LAST_PICKED_FOCAL_POINT  Reset last focal point name.        Default  Default 
ACTION_RESET_LAST_PICKED_MOUSE_REGION  Reset last picked mouse region        Default  Default 
ACTION_RESET_TIME_COUNTER_1  Reset time counter #1        Default  Default 
ACTION_RESET_TIME_COUNTER_2  Reset time counter #2        Default  Default 
ACTION_RESET_TIME_COUNTER_3  Reset time counter #3        Default  Default 
ACTION_SET_BOOKMARK_ENTITY_BASE_OBJECT_TYPE  Formation takeoff command - from the leader to the formation  const string &      Default  Default 
ACTION_SET_CURRENT_HEIGHT_CHECK_POINT  Set current height as check point for height offset        Default  Default 
ACTION_SET_CURRENT_RELATIVE_ENTITY  Sets current relative entity.  const int      Entity Identifier  Entity ID 
ACTION_SET_CURRENT_RELATIVE_ENTITY_NAME  Sets current relative entity name.  const string &      Entity Identifier  Entity Name 
ACTION_SET_CURRENT_TRAINEE_GRADE  Set current trainee grade  const int      Default  Default 
ACTION_SET_CURRENT_TRAINEE_SUBJECT  Set current trainee subject  const string &      Default  Default 
ACTION_SET_ENTITY_BRAIN_STATUS  Set the status of specified agent.  const string &  const string &    Default  Default 
ACTION_SET_ENTITY_DYNAMIC_DATA  Set dynamic data to transfer between brains within the entity. Set the title and the value you want to transfer  const string &  const string &    Default  Default 
ACTION_SET_GOTO_BRAIN_NEXT_POSITION  Sets the position the next loaded goto agent needs to go to.  const LinearVec &      Default  Default 
ACTION_SET_MFD_BOTTOM_PAGE  Set the Left MFD displayed page  const string &      Default  Default 
ACTION_SET_MFD_L_PAGE  Set the Left MFD displayed page  const string &      Default  Default 
ACTION_SET_MFD_R_PAGE  Set the Left MFD displayed page  const string &      Default  Default 
ACTION_SET_MFD_SYSTEM_NAME  Set MFD name in orde rto search if displayed  const string &      Default  Default 
ACTION_SET_NEXT_AIRPORT_ROUTE_WP_FOR_QUERY  Set airport route waypoint name for query  const string &      Default  Default 
ACTION_SET_ONLINE_DIALOG_ANSWER  Set online question answer.  const int      Default  Default 
ACTION_SET_ONLINE_OPEN_QUESTION_ANSWER_BY_INDEX  Set online open question answer by index  const int  const string &    Default  Default 
ACTION_SET_REFERENCE_LINE_BY_CURRENT_NAV_LEG  Sets the line to be the current navigation leg        Default  Default 
ACTION_SET_REFERENCE_LINE_BY_FORMATION  Sets the line end point in the position in fromation. The line heading is relative to the leader heading.  const int  const float    Default  Default 
ACTION_SET_REFERENCE_LINE_BY_WAYPOINT  Set reference line by waypoint (from the previous wp)  const int      Entity Identifier  Entity ID 
ACTION_SET_REFERENCE_LINE_HEADING  Sets the heading to reach the line end  const float      Angle  Degree 
ACTION_SET_REFERENCE_LINE_MARK_MIDDLE_POINT  Mark a middle point on the current line, and publishes instructions to reach point2 on time  const float      Time  Seconds 
ACTION_SET_REFERENCE_LINE_POINT1  Set point 1 for Line Reference calculation  const LinearVec &      Coordinate System  Local 
ACTION_SET_REFERENCE_LINE_POINT1_ENTITY  Set point 1 entity  const int      Entity Identifier  Entity ID 
ACTION_SET_REFERENCE_LINE_POINT1_TIME  The planned arrival time at point1  const float      Time  Seconds 
ACTION_SET_REFERENCE_LINE_POINT2  Set point 2 for Line Reference calculation  const LinearVec &      Coordinate System  Local 
ACTION_SET_REFERENCE_LINE_POINT2_ARC_RADIUS  Sets an arc around point 2 in a required radius  const float      Length  Nautical Mile 
ACTION_SET_REFERENCE_LINE_POINT2_ENTITY  Set point 2 entity  const int      Entity Identifier  Entity ID 
ACTION_SET_REFERENCE_LINE_POINT2_TIME  The planned arrival time at point 2   const float      Time  Seconds 
ACTION_SHOW_LMS_CONTINUE_BUTTON  Show LMS continue button  const bool      Default  Default 
VI_IS_KEY_PRESSED  Is key Pressed for VI  const int  const int    Default  Default 

back to top

Icon attributes.png Required Attributes

Name
ATT_ASPECT_TO_ENTITY 
ATT_CLOSEST_TOWER_CONTROL 
ATT_CURRENT_DISPLAYED_SYSTEM 
ATT_CURRENT_WAYPOINT 
ATT_CURRENT_WAYPOINT_ID 
ATT_DISPLAYED_SYSTEM_BY_GAUGE_INDEX 
ATT_DTDATA_IS_DESIGN_TIME_ENTITY 
ATT_FORMATION_MEMBER_GROUP_ID 
ATT_FORMATION_MEMBER_LEADER_ID 
ATT_FORMATION_RELATIVE_POSITION 
ATT_GET_ANGLE_TO_RUNWAY_GLIDE_SLOPE 
ATT_GET_WAYPOINT_BY_ID 
ATT_HEADING_TRUE 
ATT_INDICATED_AIRSPEED_KNOTS 
ATT_IS_SCENE_ENTITY 
ATT_IS_TC 
ATT_LIN_VELOCITY 
ATT_NUMBER_OF_GAUGES 
ATT_NUMBER_OF_WAYPOINTS 
ATT_PARENT_GROUP_ID 
ATT_ROUTE_ITER_NEXT_WP 
ATT_ROUTE_WAYPOINT_ITERATOR 
ATT_SCENE_IS_MAIN_WINDOW 
ATT_SUBPART_ANG_FLAPS 
ATT_TC_GET_AIRPORT_WP_POSITION_BY_NAME 
ATT_TC_GLIDE_SLOPE_ANGLE 
ATT_TC_RUNWAY_TRACK 
ATT_TC_TAKEOFF_POSITION 
ATT_TRUE_HEADING 
ATT_VERTICAL_VELOCITY 

back to top

Icon actions.png Required Actions

Name
ACTION_SET_CURRENT_DISPLAYED_SYSTEM 
ACTION_UPDATE_LOCATION 

back to top,