From 79f9ad159aa71c2669ca62d313d5c0ba76ea4dfd Mon Sep 17 00:00:00 2001
From: Mauco03 <marco.gaibotti@skywarder.eu>
Date: Tue, 20 Feb 2024 15:16:14 +0100
Subject: [PATCH] [code-refactoring][functions] WIP
- added function signatures
- changed addParameters comments
---
functions/config/addParameter.m | 2 +-
functions/config/functionSignatures.json | 22 ++++++++++++++++++++++
2 files changed, 23 insertions(+), 1 deletion(-)
create mode 100644 functions/config/functionSignatures.json
diff --git a/functions/config/addParameter.m b/functions/config/addParameter.m
index 4738ffa..cfef9cf 100644
--- a/functions/config/addParameter.m
+++ b/functions/config/addParameter.m
@@ -2,7 +2,7 @@ function parameters = addParameter(name, distr, type, A, B, varargin)
% createParameter - create the struct containing the attributes to compute
% the uncertanties in a given parameter
%
-% it is assumed that the input data contains the field to be modified
+% Data is read from the common folder
%
% INPUTS:
% name, string: parameter name
diff --git a/functions/config/functionSignatures.json b/functions/config/functionSignatures.json
new file mode 100644
index 0000000..e995e02
--- /dev/null
+++ b/functions/config/functionSignatures.json
@@ -0,0 +1,22 @@
+{
+ "addParameter":
+ {
+ "inputs":
+ [
+ {"name":"parameter", "kind":"required", "type":
+ [
+ "choices={'CA', 'CYB', 'CY0', 'CNA', 'CN0', 'Cl', 'Clp', 'Cma', 'Cm0', 'Cmad', 'Cmq', 'Cnb', 'Cn0', 'Cnr', 'Cnp', 'omega', 'phi', 'structMass', 'expMass', 'thrust', 'Ixx', 'Iyy', 'Izz', 'drogueS', 'drogueMass', 'drogueCL', 'drogueCD', 'paramainS', 'paramainMass', 'paramainCL', 'paramainCD', 'rocketDiameter', 'rocketLCenter', 'centerOfMass', 'finRootChord', 'finFreeChord', 'finHeigth', 'finSemiThickness', 'ogiveLength', 'ogivePMod', 'ogiveCMod'}"
+ ],
+ "purpose":"The parameter you wish to change"},
+ {"name":"distribution", "kind":"required", "type":["integer", ">0", "<7"], "purpose":"Distribution type. See help for more info."},
+ {"name":"type", "kind":"required", "type":["integer", ">0", "<3"], "purpose":"How to apply distribution. See help for more info."},
+ {"name":"A", "kind":"required", "type":["numeric"], "purpose":"Parameter used for distribution"},
+ {"name":"B", "kind":"required", "type":["numeric"], "purpose":"Parameter used for distribution"},
+ {"name":"parameters", "kind":"ordered"}
+ ],
+ "outputs":
+ [
+ {"name":"parameter", "type":["nrows=1"]}
+ ]
+ }
+}
\ No newline at end of file
--
GitLab