ExternalInterfaceModel.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_SUPPORT_EXTERNAL_INTERFACE_MODEL
#define MODELS_SUPPORT_EXTERNAL_INTERFACE_MODEL
 
#include <vector>
 
#include "architecture/Time.h"
#include "flight/App.h"
#include "flight/FlightExecutive.h"
#include "simulation/SimulationSteps.h"
#include "utils/DataIOSocketRelay.h"
#include "utils/DataIOShmemRelay.h"
 
namespace warptwin {

    class ExternalInterfaceModel : public warpos::App {
    public:
        START_PARAMS
 
        END_PARAMS

        START_INPUTS
 
        END_INPUTS

        START_OUTPUTS
 
        END_OUTPUTS

        void connectExternalSocket(clockwerk::DataIOBase& signal, std::string mode, 
                                   const std::string &ip, int port);

        void connectExternalSharedMemory(clockwerk::DataIOBase& signal, std::string mode,
                                         const std::string shmem_address);

        ExternalInterfaceModel(warpos::FlightExecutive &executive);
        virtual ~ExternalInterfaceModel();
    protected:
        int16 start() override;
        int16 execute() override; 

        int _syncSockets();
        int _syncShmem();
 
        // Where our pointers to relays are held. Note these must be recorded
        // as DataIOBase
        std::vector<DataIOSocketRelay*> _socket_relays;
        std::vector<DataIOShmemRelay*> _shmem_relays;
    };
 
}
 
#endif