WarpTwin
Documentation for WarpTwin models and classes.
Loading...
Searching...
No Matches
ProximityMonitor.h
Go to the documentation of this file.
1/******************************************************************************
2* Copyright (c) ATTX INC 2025. All Rights Reserved.
3*
4* This software and associated documentation (the "Software") are the
5* proprietary and confidential information of ATTX INC. The Software is
6* furnished under a license agreement between ATTX and the user organization
7* and may be used or copied only in accordance with the terms of the agreement.
8* Refer to 'license/attx_license.adoc' for standard license terms.
9*
10* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
11* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION
12* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or
13* transmitted in any form or by any means, for any purpose, without the express
14* written permission of ATTX INC.
15******************************************************************************/
16/*
17Proximity Monitor header file
18
19Author: Sam Matez
20*/
21/*
22Metadata for MS GUI:
23imdata = {"exclude" : True}
24*/
25
26#ifndef MONITORS_PROXIMITY_MONITOR_H
27#define MONITORS_PROXIMITY_MONITOR_H
28
30#include "architecture/Time.h"
33#include "simulation/Model.h"
34
35namespace warptwin {
36
40 MODEL(ProximityMonitor)
41 public:
42 // Model params
43 // NAME TYPE DEFAULT VALUE
46 SIGNAL(trigger_range, double, 1000.0)
48
49 // Model inputs
50 // NAME TYPE DEFAULT VALUE
53 SIGNAL(chief_position, CartesianVector3, CartesianVector3({0.0, 0.0, 0.0}))
55 SIGNAL(deputy_position, CartesianVector3, CartesianVector3({0.0, 0.0, 0.0}))
57
60 SIGNAL(range, double, 0.0)
63 SIGNAL(trigger, bool, false)
65
66 protected:
67 double _range; // stores calculated range
68 CartesianVector3 _rel_position; // stores relative position vector
69
74 int16 execute() override;
75 };
76
77}
78
79#endif
#define SIGNAL(NAME, TYPE, INITIAL_VALUE)
Definition appmacros.h:27
#define START_PARAMS
Definition appmacros.h:42
#define END_OUTPUTS
Definition appmacros.h:33
#define END_PARAMS
Definition appmacros.h:47
#define START_OUTPUTS
Definition appmacros.h:28
#define END_INPUTS
Definition appmacros.h:40
#define START_INPUTS
Definition appmacros.h:35
#define CartesianVector3
Definition mathmacros.h:43
Class to propagate CR3BP dynamics in characteristic units.
Definition statistics.hpp:22
SIGNAL(_mu, double, warpos::earth_wgs84.mu)
@ MODEL
Simplified dynamics model representing motion in the circular restricted 3 body problem.
Definition ImNode.h:31
int16 execute() override
Function to check monitor input conditions and set trigger flag accordingly. Should be implemented in...
MODEL(ProximityMonitor) public CartesianVector3 _rel_position
Definition ProximityMonitor.h:40