diguyExerciseInterface.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2016 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguyExerciseInterface
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyExerciseInterface_H
#define __diguyExerciseInterface_H

#ifdef SWIG
%module diguyExerciseInterface
#else
#define CPLUSPLUS_ONLY
#endif

#include <diguyExerciseInterface.h>

#ifdef CPLUSPLUS_ONLY

class bdiExerciseInterface;
class diguyCharacter;

#include <stdio.h> // for NULL
#include <diguy_constants.h>

#endif /* CPLUSPLUS_ONLY */


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyExerciseInterface
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function sends an xc_set_tin_tod PDU.  This PDU
         **    tells a remote DI-Guy application the simulated time of day
         **    at which its scenario is supposed to begin.  Doing this
         **    provides a conceptual link between scenario time, which
         **    nominally starts at zero, and wall-clock time.  This makes
         **    it possible for a scenario to be run under different
         **    simulated lighting conditions.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::set_tin_time_of_day() call.
         **
         *b  Arguments:
         **
         *a    site - destination host id (65535 for all sites)
         *a    host - destination host id (65535 for all hosts)
         *a    ttod - tin time of day (seconds after midnight)
         */
        void send_xc_set_tin_tod(unsigned short site,
                unsigned short host,
                float ttod);

        /*l
         *b  Description:
         **
         **    This function sends an xc_load_scenario PDU.  This PDU
         **    tells a remote DI-Guy application to load a particular
         **    scenario file.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::load() call.
         **
         *b  Arguments:
         **
         *a    site     - destination host id (65535 for all sites)
         *a    host     - destination host id (65535 for all hosts)
         *a    filename - scenario to load
         *a    refname  - scenario reference name
         */
        void send_xc_load_scenario(unsigned short site,
                unsigned short host,
                const char* filename,
                const char* refname);

        /*l
         *b  Description:
         **
         **    This function sends an xc_save_scenario PDU.  This PDU
         **    tells a remote DI-Guy application to save a particular
         **    scenario file.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::save_as() call.
         **
         *b  Arguments:
         **
         *a    site     - destination host id (65535 for all sites)
         *a    host     - destination host id (65535 for all hosts)
         *a    filename - scenario to load
         *a    use_user_name  - user name to uniquely identify the file
         */
        void send_xc_save_scenario(unsigned short site,
                unsigned short host,
                const char* filename,
                const int use_user_name);

        /*l
         *b  Description:
         **
         **    This function sends an xc_reset_scenario PDU.  This PDU
         **    tells a remote DI-Guy application to reset the current
         **    scenario file.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::reset() call.
         **
         *b  Arguments:
         **
         *a    site     - destination host id (65535 for all sites)
         *a    host     - destination host id (65535 for all hosts)
         */
        void send_xc_reset_scenario(unsigned short site,
                unsigned short host);

        /*l
         *b  Description:
         **
         **    This function sends an xc_merge_scenario PDU.  This PDU
         **    tells a remote DI-Guy application to merge a particular
         **    scenario file.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::merge() call.
         **
         *b  Arguments:
         **
         *a    site             - destination host id (65535 for all sites)
         *a    host             - destination host id (65535 for all hosts)
         *a    ttod             - tin time of day for the merged scenario
         *a                       (seconds after midnight)
         *a    refx, refy, refz - transformation reference point in merged
         *a                       scenario (point around which translation
         *a                       and rotation will occur)
         *a    tx, ty, tz       - translation of reference point in merged
         *a                       scenario
         *a    rz, rx, ry       - rotation of reference point in merged scenario
         *a    filename         - filename of scenario to merge
         *a    collision_suffix - suffix to be used in event of name
         *a                       conflicts
         */
        void send_xc_merge_scenario(unsigned short site,
                unsigned short host,
                float ttod,
                float refx, float refy, float refz,
                float tx, float ty, float tz,
                float rz, float rx, float ry,
                const char* filename,
                const char* suffix);

        /*l
         *b  Description:
         **
         **    This function sends an xc_trigger_script PDU.  This PDU
         **    tells a remote DI-Guy application to trigger the named
         **    script.
         **
         **    The remote DI-Guy application essentially does a
         **    diguyScenario::trigger_script() call.
         **
         *b  Arguments:
         **
         *a    site        - destination host id (65535 for all sites)
         *a    host        - destination host id (65535 for all hosts)
         *a    script_name - name of the script to be triggered
         */
        void send_xc_trigger_script(unsigned short site,
                unsigned short host,
                const char* script_name);

        /*l
         *b  Description:
         **
         **    This function sends an xc_control PDU.  This PDU tells a
         **    remote DI-Guy application to PLAY, STOP, RESET, etc.
         **
         *b  Arguments:
         **
         *a    site    - destination host id (65535 for all sites)
         *a    host    - destination host id (65535 for all hosts)
         *a    command - command string.  Valid values are "RESET",
         *a              "RUN", "STOP", "FF", "REWIND"
         */
        void send_xc_control(unsigned short site,
                unsigned short host,
                const char* command);

        /*l
         *b  Description:
         **
         **    This function sends an xc_time_now PDU.  This PDU tells all
         **    remote DI-Guy applications what the simulated time of day is
         **    right now.  There is no way to target this message at
         **    particular DI-Guy hosts.  It is received and processed by all
         **    DI-Guy applications in the DIS exercise.
         **
         *b  Arguments:
         **
         *a    tod           - time of day: number of seconds since midnight,
         *a                    where 0.0 <= tod < 86400.0
         *a    smooth_period - how many real seconds should be taken to get
         *a                    into sync
         **
         **    Scenarios can proceed from one day to the next, up to a length of
         **    24 hours.  When midnight comes, tod should be specified AS ZERO,
         **    and should increase from there.  Values less than zero or greater
         **    than or equal to 86400.0 will NOT be sent over the network.  In
         **    the case nothing will be sent.
         */
        void send_xc_time_now(float tod, float smooth_period);

        /*l
         *b  Description:
         **
         **    This function sends an xc_eval_script PDU.  This PDU tells a
         **    remote DI-Guy application to evaluate a literal piece of
         **    script text.
         **
         *b  Arguments:
         **
         *a    site    - destination host id (65535 for all sites)
         *a    host    - destination host id (65535 for all hosts)
         *a    text    - text of the script to be executed
         */
        void send_xc_eval_script(unsigned short site,
                unsigned short host,
                const char* text);

        /*l
         *b  Description:
         **
         **    This function sends an xc_enter_slave PDU. This PDU tells a remote
         **    DI-Guy application to start slaving it's camera to incoming
         **    camera/time packets.
         **
         *b  Arguments:
         **
         *a    site    - destination host id (65535 for all sites)
         *a    host    - destination host id (65535 for all hosts)
         */
        void send_xc_enter_slave_mode(unsigned short site, unsigned short host);

        /*l
         *b  Description:
         **
         **    This function sends an xc_exit_slave PDU. This PDU tells a remote
         **    DI-Guy application to stop slaving it's camera to incoming
         **    camera/time packets.
         **
         *b  Arguments:
         **
         *a    site    - destination host id (65535 for all sites)
         *a    host    - destination host id (65535 for all hosts)
         */
        void send_xc_exit_slave_mode(unsigned short site, unsigned short host);


        /*l
         *b  Description:
         **
         **    This function sends a custom AI message PDU. This PDU is mapped
         **    into a diguyCharacter::agent_accept_message() function call on
         **    the receiving side.
         **
         *b  Arguments:
         **
         *a    character      - pointer to the remote diguyCharacter
         *a    sender         - pointer to local diguyCharacter
         *a    message_type   - type of message is being sent
         *a    message        - message string
         *a    message_params - optional parameter string
         **
         **    Use diguyExerciseInterface::get_net_id() to get the name of the
         **    character that the remote machine will see the sender as.
         */
        int send_message_to_character(diguyCharacter* character,
                diguyCharacter* sender,
                const char* message_type,
                const char* message,
                const char* message_params = NULL);

        /*l
         *b  Description:
         **
         **    This function sends a custom AI message PDU.  This PDU is mapped
         **    into a diguyCharacterGroup::send_message_to_all_members() on all
         **    clients.
         **
         *b  Arguments:
         **
         *a    group_name     - name of the diguyCharacterGroup to target
         *a    sender         - pointer to local diguyCharacter
         *a    message_type   - what type of message is being sent
         *a    message        - the message string
         *a    message_params - optional parameter string
         **
         **    Use diguyExerciseInterface::get_net_id() to get the name of the
         **    character that the remote machine will see the sender as.
         */
        int send_message_to_group(const char* group_name,
                diguyCharacter* sender,
                const char* message_type,
                const char* message,
                const char* message_params = NULL);

        /*l
         *b  Description:
         **
         **    This function sends a custom AI message PDU.  This PDU is mapped
         **    into a diguyCharacter::agent_broadcast_message() on all clients.
         **
         *b  Arguments:
         **
         *a    sender         - pointer to the diguyCharacter that is broadcasting
         *a                     the message
         *a    radius         - how far to broadcast the message
         *a    message_type   - what type of message is being sent
         *a    message        - the message string
         *a    message_params - optional parameter string
         */
        int broadcast_message(diguyCharacter* sender,
                float radius,
                const char* message_type,
                const char* message,
                const char* message_params = NULL);

        /*l
         *b  Description:
         **
         **    This function sends a custom AI message PDU.  This PDU is mapped
         **    into a diguyCharacter::agent_broadcast_message_to_group() on all
         **    clients.
         **
         *b  Arguments:
         **
         *a    sender         - pointer to the diguyCharacter that is broadcasting
         *a                     the message
         *a    group_name     - the group that receive the message
         *a    radius         - how far to broadcast the message
         *a    message_type   - what type of message is being sent
         *a    message        - the message string
         *a    message_params - optional parameter string
         */
        int broadcast_message_to_group(diguyCharacter* sender,
                const char* group_name,
                float radius,
                const char* message_type,
                const char* message,
                const char* message_params = NULL);

        /*l
         *b  Returns:
         **
         **    "sitenum_hostnum_idnum" as a string
         **
         **    Useful for knowing the name that  this entity will have on remote
         **    machines. This string should be copied.
         */
        const char* get_net_id(diguyCharacter* character);

        /*l
         *b  Returns:
         **
         **    HLA federate type string, or "NA" if using DIS
         **
         */
        const char* get_federate_type();



/****************************************************************************/
/****************************************************************************/
/****************************************************************************/

        int convert_mgrs_to_local(const char* MGRS_str, float* x, float* y, float* z);
        const char* convert_local_to_mgrs(float x, float y, float z);

        // returns straightforward latitude and longitude coordinates
        float convert_local_to_lat(float x, float y, float z);
        double convert_local_to_lat_double(double x, double y, double z );
        float convert_local_to_long(float x, float y, float z);
        double convert_local_to_long_double(double x, double y, double z );

        // returns latitude and longitude in degrees, minutes, seconds
        const char* convert_local_to_lat_long_string(float x, float y, float z);

        int convert_lat_long_to_local(float lat, float lon, float* x, float* y, float* z);
        int convert_lat_long_to_local_double(double lat, double lon, float* x, float* y, float* z);


#ifdef CPLUSPLUS_ONLY

        bdiExerciseInterface* get_scripted_object() {return m_bdiExerciseInterface;}

private:

        friend class bdiExerciseInterface;

        /*l
         **    A private constructor.
         */
        diguyExerciseInterface(bdiExerciseInterface* ei);

        /*l
         **    A pointer to internal data.
         */
        bdiExerciseInterface* m_bdiExerciseInterface;

#endif /* CPLUSPLUS_ONLY */

};


#endif /* __diguyExerciseInterface_H */