WarpTwin
Documentation for WarpTwin models and classes.
Loading...
Searching...
No Matches
PidTranslationalControl.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/*
17Simple PID header file
18
19Author: Alex Reynolds
20*/
21/*
22Metadata for MS GUI:
23imdata = {"exclude" : True}
24*/
25
26#ifndef SUPPORT_PID_TRANSLATIONAL_CONTROL_H
27#define SUPPORT_PID_TRANSLATIONAL_CONTROL_H
28
29#include "simulation/Model.h"
30#include "frames/Frame.h"
31#include "frames/frameutils.h"
32
33namespace warptwin {
34
41 MODEL(PidTranslationalControl)
42 public:
43 // Model params
44 // NAME TYPE DEFAULT VALUE
47 SIGNAL(P, double, 0.0)
49 SIGNAL(I, double, 0.0)
51 SIGNAL(D, double, 0.0)
53
54 // Model inputs
55 // NAME TYPE DEFAULT VALUE
58 SIGNAL(cmd_state, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
60 SIGNAL(act_state, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
62 SIGNAL(deriv_state, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
64
65 // Model outputs
66 // NAME TYPE DEFAULT VALUE
69 SIGNAL(control_cmd, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
71 SIGNAL(error, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
73 SIGNAL(integrated_error, CartesianVector3, CartesianVector3({0.0,0.0,0.0}))
75
76 protected:
77 int16 execute();
78 };
79
80}
81
82#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...