From 6ad064e26742d60852f38143dc7696290e78cac3 Mon Sep 17 00:00:00 2001
From: Mauco03 <marco.gaibotti@skywarder.eu>
Date: Thu, 4 Apr 2024 14:57:57 +0200
Subject: [PATCH] [msa-refactoring][classes] Applying corrections
- Added headers
- Removed unnecessary lines/files
---
_old/Motors.mat | 3 ---
classes/Config.m | 4 +++-
classes/Mission.m | 14 +++++++++-----
classes/components/Environment.m | 13 +++++++++++--
classes/components/Parachute.m | 16 +++++++++++-----
classes/components/Pitot.m | 12 ++++++++++--
classes/components/WindCustom.m | 13 ++++++++++---
classes/components/WindMatlab.m | 13 +++++++++++--
8 files changed, 65 insertions(+), 23 deletions(-)
delete mode 100644 _old/Motors.mat
diff --git a/_old/Motors.mat b/_old/Motors.mat
deleted file mode 100644
index 4a1e565..0000000
--- a/_old/Motors.mat
+++ /dev/null
@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:5d321100dbc7d5a66a7a456ffce103f26a2b2055706f70533f5212b400ef1003
-size 242474
diff --git a/classes/Config.m b/classes/Config.m
index 7995125..1a68e29 100644
--- a/classes/Config.m
+++ b/classes/Config.m
@@ -1,7 +1,8 @@
classdef(Abstract) Config < handle
% Config: Represents an abstraction layer for all config-dependent Classes
% Config standardizes property management and declares fundemental
-% properties (see doc for more info)
+% methods (see doc for more info)
+
properties(Abstract, Access = protected)
configName {mustBeTextScalar}
@@ -34,6 +35,7 @@ classdef(Abstract) Config < handle
%
% WARNING: If second output is used, only values with public
% getAccess will be read
+
arguments
obj
preset char {mustBeMember(preset, {'readable', 'writable', ''})} = ''
diff --git a/classes/Mission.m b/classes/Mission.m
index d3b2508..23eb161 100644
--- a/classes/Mission.m
+++ b/classes/Mission.m
@@ -1,10 +1,14 @@
classdef Mission < Config
-% Config: Contains names and paths needed to access mission-dependent config files
+% Mission: Contains names and paths needed to access mission-dependent
+% config files
%
-% To get an empty Mission, run "Mission()", or "Mission(false)"
-% To get an initialized Mission, run "Mission(true)"
-% Where the argument specifies whether to read config files or not
-
+% Constructor:
+% - Mission: Creates an instance of the Mission class.
+% Loaded config: missionConfig.m
+% Loaded data: -
+% Arguments:
+% - loadConfig: bool, Whether to load config file or return
+% an empty mission
properties
name % Mission name, used to access <mission> folder
diff --git a/classes/components/Environment.m b/classes/components/Environment.m
index 85dbeb1..3923b1d 100644
--- a/classes/components/Environment.m
+++ b/classes/components/Environment.m
@@ -1,6 +1,15 @@
classdef Environment < Component
- %ENVIRONMENT Summary of this class goes here
- % Detailed explanation goes here
+% Environment: Represents launch site dependent variables.
+%
+% Constructor:
+% - Environment: Creates an instance of the Environment class.
+% Loaded config: environmentConfig.m
+% Loaded data: -
+% Arguments:
+% - mission: Mission, mission object
+% - motor: Motor, used to compute pin distance
+% - varIn: (optional) config source. Alternative to config.m
+% file
properties
lat0 double % [deg] Launchpad latitude
diff --git a/classes/components/Parachute.m b/classes/components/Parachute.m
index e03bac7..a321bd2 100644
--- a/classes/components/Parachute.m
+++ b/classes/components/Parachute.m
@@ -1,6 +1,15 @@
classdef Parachute < Component
- %PARACHUTE Summary of this class goes here
- % Detailed explanation goes here
+% Parachute: Represents a parachute component.
+%
+% Constructor:
+% - Parachute: Creates an instance of the Parachute class.
+% Loaded config: rocketConfig.m > parachute
+% Loaded data: -
+% Arguments:
+% - mission: Mission, mission object
+% - varIn: (optional) config source. Alternative to config.m
+% file
+
properties
name {mustBeTextScalar} = ''
surface double % [m^2] Surface
@@ -30,11 +39,8 @@ classdef Parachute < Component
mission Mission = Mission()
varIn = []
end
- % if nargin > 0 && nargin < 2, error('Too few arguments. Type help for more info'); end
- % if nargin > 3, error('Too many arguments.'); end
obj@Component(mission, varIn);
- %obj.motor = motor;
end
end
end
diff --git a/classes/components/Pitot.m b/classes/components/Pitot.m
index b546754..1d8cd48 100644
--- a/classes/components/Pitot.m
+++ b/classes/components/Pitot.m
@@ -1,6 +1,14 @@
classdef Pitot < Component
- %PITOT Summary of this class goes here
- % Detailed explanation goes here
+% Pitot: Represents a pitot tube.
+%
+% Constructor:
+% - Pitot: Creates an instance of the Pitot class.
+% Loaded config: rocketConfig.m > pitot
+% Loaded data: -
+% Arguments:
+% - mission: Mission, mission object
+% - varIn: (optional) config source. Alternative to config.m
+% file
properties
length double % [m] Pitot tube length
diff --git a/classes/components/WindCustom.m b/classes/components/WindCustom.m
index 58547c2..a0159ed 100644
--- a/classes/components/WindCustom.m
+++ b/classes/components/WindCustom.m
@@ -1,7 +1,14 @@
classdef WindCustom < Component
- %UNTITLED Summary of this class goes here
- % Detailed explanation goes here
-
+% WindCustom: Represents Skyward's custom wind model.
+%
+% Constructor:
+% - WindCustom: Creates an instance of the WindCustom class.
+% Loaded config: windConfig.m > windCustom
+% Loaded data: -
+% Arguments:
+% - mission: Mission, mission object
+% - varIn: (optional) config source. Alternative to config.m
+% file
properties
altitudes (1, :)
diff --git a/classes/components/WindMatlab.m b/classes/components/WindMatlab.m
index d1ef4b5..613fd81 100644
--- a/classes/components/WindMatlab.m
+++ b/classes/components/WindMatlab.m
@@ -1,6 +1,15 @@
classdef WindMatlab < Component
- %UNTITLED Summary of this class goes here
- % Detailed explanation goes here
+% WindMatlab: Represents matlab wind variables.
+%
+% Constructor:
+% - WindMatlab: Creates an instance of the WindMatlab class.
+% Loaded config: windConfig.m > windMatlab
+% Loaded data: -
+% Arguments:
+% - mission: Mission, mission object
+% - environment: Environment, used to get launch coordinates
+% - varIn: (optional) config source. Alternative to config.m
+% file
properties
DayMin % [d] Minimum Day of the launch
--
GitLab