TimedImpulsiveBurnModel.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. 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 INC.
******************************************************************************/
/*
Impulse model header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Timed Impulsive Burn",
          "exclude" : False,
          "category" : "GN&C"
}
aliases = {"body_frame" : "Spacecraft Body",
           "burn_frame" : "Frame of Burn Vector",
           "time_of_ignition" : "Burn Time",
           "deltav__burn" : "Burn Vector",
           "current_time" : "Time"
}
*/
#ifndef MODELS_ACTUATORS_TIMED_IMPULSIVE_BURN_MODEL_H
#define MODELS_ACTUATORS_TIMED_IMPULSIVE_BURN_MODEL_H
 
#include "simulation/Model.h"
#include "core/CartesianVector.hpp"
#include "frames/Frame.h"
#include "frames/Body.h"
#include "frames/Node.h"
#include "models/actuators/ImpulseModel.h"
#include "monitors/TimeTriggerMonitor.h"
 
namespace warptwin {

    MODEL(TimedImpulsiveBurnModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(body_frame,              Body*,                 nullptr)
            SIGNAL(burn_frame,              Frame*,                nullptr)
            SIGNAL(time_of_ignition,        clockwerk::Time,        clockwerk::Time(UINT32_MAX, 0))
            SIGNAL(deltav__burn,            CartesianVector3,      CartesianVector3({0.0, 0.0, 0.0}))
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            SIGNAL(current_time,            clockwerk::Time,        clockwerk::Time())
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
        
        END_OUTPUTS

        warptwin::TimeTriggerMonitor* timeTriggerMonitor() {return &_time_trigger;}

        warptwin::ImpulseModel* impulseModel() {return &_impulse;}
    protected:
        int16 start() override;
        int16 execute() override; 
 
        // Internal models and monitors
        TimeTriggerMonitor _time_trigger;
        ImpulseModel _impulse;
 
        // Node at which forces will be applied
        Node _force_node;
 
        // Boolean indicating whether trigger has happened before
        bool _triggered = false;
    };
}
 
#endif