diff --git a/_old/Motors.mat b/_old/Motors.mat deleted file mode 100644 index 4a1e5652675f11a71eb9459430174f255ba6d74b..0000000000000000000000000000000000000000 --- 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 7995125bce9b18b34df494e5632f85b25498acb6..1a68e29b7b40c97dea3d3a44ae2f029279a1bacc 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 d3b25085793431c12d3b85341275e127c818f321..23eb161da9b5f35d48e730b21b12e83315af96fb 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 85dbeb175c2077eef42df55382ed1ded00d45c1e..3923b1d3885cc968e053091c3527638a14262da1 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 e03bac73dbf2ca53a8296a12731d48aa539244b8..a321bd2b2db10081635a7e93f8eed42afa242710 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 b5467542bfcd95980313a380830c348374c39049..1d8cd4885a8e90c1f0fcb17f681edfdbf77f5118 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 58547c2f788f0bd5125623d95b81c021f39ed6d6..a0159ed60ec5d14b108f207aa3183087d493fb0b 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 d1ef4b559a03a84a3c068617263807c63c6dcc3a..613fd819a01bcbbc10edb343ff51791cbe982310 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