diff --git a/.github/workflows/style_all.yml b/.github/workflows/style_all.yml index ebb658bb..fa1a62e3 100644 --- a/.github/workflows/style_all.yml +++ b/.github/workflows/style_all.yml @@ -30,7 +30,6 @@ jobs: run: cp config/adamant.configuration.yaml.original config/adamant.configuration.yaml - name: Check all style run: bash env/github_run.sh "redo style_all" - continue-on-error: true - name: Archive logs for failed style checks if: always() # Make sure this runs even if `redo style_all` fails uses: actions/upload-artifact@v3 diff --git a/config/README.md b/config/README.md index 5aeea022..c1ca4c17 100644 --- a/config/README.md +++ b/config/README.md @@ -20,7 +20,7 @@ You can now modify the values in `adamant.configuration.yaml` to work for your p version control system if you intend on merging changes from your Adamant repository back into the framework root repository. -Version controlling the configuration file is usually desireable. To accomplish this, copy the +Version controlling the configuration file is usually desirable. To accomplish this, copy the Adamant default configuration into your project specific repository: ``` diff --git a/doc/QuickStartGuide.md b/doc/QuickStartGuide.md index 2a3d239a..41936738 100644 --- a/doc/QuickStartGuide.md +++ b/doc/QuickStartGuide.md @@ -31,9 +31,9 @@ In Adamant, anything constructed by the build system will always be put into a d There are some basic `redo` commands available in Adamant that are almost always available, and can be particularly useful: * `redo what` - The build system will explore the build path and print a list of the available outputs that can be built from the current directory. The list returned is not guaranteed to be complete, but this deficiency should not hinder anyone except for the most advanced Adamant users. -* `redo all` - The build system will try to generate every output available within a directory's `build/` directory. What `redo all` will construct can be visualized by using `redo what`. Note, running simply `redo` is assumed by `redo` to be equivelant to running `redo all`. +* `redo all` - The build system will try to generate every output available within a directory's `build/` directory. What `redo all` will construct can be visualized by using `redo what`. Note, running simply `redo` is assumed by `redo` to be equivalent to running `redo all`. * `redo clean` - This removes any `build/` directories found recursively from where it is run. -* `redo test_all` - Recursively find any unit tests from where this command is run, compile them, and run them, outputing a simple pass/fail report to the terminal. +* `redo test_all` - Recursively find any unit tests from where this command is run, compile them, and run them, outputting a simple pass/fail report to the terminal. * `redo publish` - Recursively "publish" any documentation found from this directory. For more detail on "publishing" documentation see the "Creating Component Documentation" section. * `redo style` - Run style checks on all source files (Python, Ada, and YAML) found in this directory. * `redo targets` - Show all available build targets, see the "Setting the Build Target" section. diff --git a/doc/architecture_description_document/architecture_description_document.tex b/doc/architecture_description_document/architecture_description_document.tex index 7ec38d25..d98d9065 100644 --- a/doc/architecture_description_document/architecture_description_document.tex +++ b/doc/architecture_description_document/architecture_description_document.tex @@ -27,7 +27,7 @@ \section{Concepts} \item \textbf{Encapsulation} - A component hides the details of its internal behavior and state and only allows other components to access its functionality through the interface it presents. \item \textbf{Independence} - Components do not depend on other components, they depend only on their interfaces. This means that changes to one component are unlikely to ripple through the entire system. \item \textbf{Reusability} - Some components may be designed for a project-specific task, however, many components can be designed in a generic way such that they can be reused in similar systems with no modification. In addition, a component can be placed in a variety of execution contexts and be still expected to function as designed. - \item \textbf{Replacability} - Because a component is simply represented by its interfaces, it can substituted for another component as long as it adheres to the same interface. + \item \textbf{Replaceability} - Because a component is simply represented by its interfaces, it can substituted for another component as long as it adheres to the same interface. \end{itemize} Components in Adamant communicate with one another through strongly typed \textit{connectors}. Components can have many connectors, of many different types, which can either send or receive data or both. Because connectors are exposed in the design, data flow within an Adamant architecture is not obscured, but rather can be easily inspected by a viewer of the design. @@ -168,7 +168,7 @@ \subsubsection{Component Examples} % parameters \begin{figure}[H] \includegraphics[width=1.0\textwidth,center]{../example_architecture/build/eps/example_parameters.eps} - \caption{\texttt{Example\_Parameters} component which takes requests for parameter values by identifier, and synchronously returns them to the requestor} + \caption{\texttt{Example\_Parameters} component which takes requests for parameter values by identifier, and synchronously returns them to the requester} \end{figure} The \texttt{Example\_Parameters} component's primary task is to push the current value of parameters to components throughout the system. To accomplish this, it has an arrayed \textit{provide} connector through which it sends parameter updates to destination components. The component also includes a connector which allows parameter values to be changed by command. diff --git a/doc/example_architecture/array_register_set/main.adb b/doc/example_architecture/array_register_set/main.adb index 1a015f1a..cbc93207 100644 --- a/doc/example_architecture/array_register_set/main.adb +++ b/doc/example_architecture/array_register_set/main.adb @@ -18,7 +18,7 @@ begin -- Read and write registers but only access certain components. The -- compiler will ensure that the ENTIRE register is read/written - -- during the folling operations. + -- during the following operations. if Registers (1).Hw_1_Enabled = Enable and then Registers (4).Hw_2_Enabled = Enable then diff --git a/doc/example_architecture/command_component/command_component.component.yaml b/doc/example_architecture/command_component/command_component.component.yaml index 41073d11..06a44851 100644 --- a/doc/example_architecture/command_component/command_component.component.yaml +++ b/doc/example_architecture/command_component/command_component.component.yaml @@ -2,7 +2,7 @@ execution: passive description: This is the command component, which executes commands. connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to register the components commands at initialization, and send command responses after execution. diff --git a/doc/example_architecture/command_component/component-command_component-implementation.adb b/doc/example_architecture/command_component/component-command_component-implementation.adb index 8d6e262a..801cb5d4 100644 --- a/doc/example_architecture/command_component/component-command_component-implementation.adb +++ b/doc/example_architecture/command_component/component-command_component-implementation.adb @@ -9,7 +9,7 @@ package body Component.Command_Component.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/doc/example_architecture/command_component/component-command_component-implementation.ads b/doc/example_architecture/command_component/component-command_component-implementation.ads index bd0328a6..bf504dbf 100644 --- a/doc/example_architecture/command_component/component-command_component-implementation.ads +++ b/doc/example_architecture/command_component/component-command_component-implementation.ads @@ -33,7 +33,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T); --------------------------------------- diff --git a/doc/example_architecture/command_view.science_assembly.view.yaml b/doc/example_architecture/command_view.science_assembly.view.yaml index 5f4c3a7b..d9c96fd4 100644 --- a/doc/example_architecture/command_view.science_assembly.view.yaml +++ b/doc/example_architecture/command_view.science_assembly.view.yaml @@ -37,7 +37,7 @@ filters: # Required - The filter type. Filter types available are: # component_name - filter by component names # component_type - filter by component types - # component_execution - filter by component exucution types (active or passive) + # component_execution - filter by component execution types (active or passive) # component_context - filter by component and all it's immediate connections # connector_name - filter by connector_names # connecter_type - filter by connector type diff --git a/doc/example_architecture/data_dependency_component/component-data_dependency_component-implementation.ads b/doc/example_architecture/data_dependency_component/component-data_dependency_component-implementation.ads index ce502b28..cbe3c31e 100644 --- a/doc/example_architecture/data_dependency_component/component-data_dependency_component-implementation.ads +++ b/doc/example_architecture/data_dependency_component/component-data_dependency_component-implementation.ads @@ -34,7 +34,7 @@ private ----------------------------------------------- -- Description: -- A set of data dependencies for the Data Dependency Component. - -- Function which retreives a data dependency. + -- Function which retrieves a data dependency. -- The default implementation is to simply call the Data_Product_Fetch_T_Request connector. Change the implementation if this component -- needs to do something different. overriding function Get_Data_Dependency (Self : in out Instance; Id : in Data_Product_Types.Data_Product_Id) return Data_Product_Return.T is (Self.Data_Product_Fetch_T_Request ((Id => Id))); diff --git a/doc/example_architecture/enum_py/test.py b/doc/example_architecture/enum_py/test.py index 92fe6d47..ebc2181a 100644 --- a/doc/example_architecture/enum_py/test.py +++ b/doc/example_architecture/enum_py/test.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # Build our dependencies using the build system. -# This is necessary because some of the depdencies we +# This is necessary because some of the dependencies we # have are autogenerated. from util import pydep diff --git a/doc/example_architecture/example_register.record.yaml b/doc/example_architecture/example_register.record.yaml index 1232e553..0d963471 100644 --- a/doc/example_architecture/example_register.record.yaml +++ b/doc/example_architecture/example_register.record.yaml @@ -1,8 +1,8 @@ --- description: This is an example packed register. preamble: | - type Enable_Disable_Type is (Disabl, Enable); - for Enable_Disable_Type use (Disabl => 0, Enable => 1); + type Enable_Disable_Type is (Disable, Enable); + for Enable_Disable_Type use (Disable => 0, Enable => 1); type Fourteen_Bit_Uint is mod 2**14; # List the record fields. The whole register must be 32-bits in size. fields: diff --git a/doc/example_architecture/example_time.component.yaml b/doc/example_architecture/example_time.component.yaml index 180af791..4a05d2ce 100644 --- a/doc/example_architecture/example_time.component.yaml +++ b/doc/example_architecture/example_time.component.yaml @@ -2,7 +2,7 @@ description: This component provides system time to components in the assembly. execution: passive preamble: | - type Time_Source_Type is (Sofware, Hardware); + type Time_Source_Type is (Software, Hardware); discriminant: description: The discriminant is used to specify the time source. parameters: diff --git a/doc/example_architecture/fault_component/fault_component.faults.yaml b/doc/example_architecture/fault_component/fault_component.faults.yaml index 9e6ffcd6..cac7df6a 100644 --- a/doc/example_architecture/fault_component/fault_component.faults.yaml +++ b/doc/example_architecture/fault_component/fault_component.faults.yaml @@ -6,7 +6,7 @@ faults: # Required - the name of the fault - name: Discontinuous_Time_Fault # Optional - a description of the fault - description: A discontinous time was detected by the component. + description: A discontinuous time was detected by the component. # Optional - the parameter type to include with the fault param_type: Packed_U32.T # Optional - a statically defined ID for the fault diff --git a/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.adb b/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.adb index 1bcb3dc2..b5482966 100644 --- a/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.adb +++ b/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.adb @@ -66,7 +66,7 @@ package body Component.Fault_Component.Implementation.Tester is ----------------------------------------------- -- Description: -- A set of faults for the Fault Component. - -- A discontinous time was detected by the component. + -- A discontinuous time was detected by the component. overriding procedure Discontinuous_Time_Fault (Self : in out Instance; Arg : in Packed_U32.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.ads b/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.ads index c1e2ce5e..4ffd223e 100644 --- a/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.ads +++ b/doc/example_architecture/fault_component/test/component-fault_component-implementation-tester.ads @@ -60,7 +60,7 @@ package Component.Fault_Component.Implementation.Tester is ----------------------------------------------- -- Description: -- A set of faults for the Fault Component. - -- A discontinous time was detected by the component. + -- A discontinuous time was detected by the component. overriding procedure Discontinuous_Time_Fault (Self : in out Instance; Arg : in Packed_U32.T); -- A time restart at zero seconds epoc was detected by the component. overriding procedure Zero_Time_Fault (Self : in out Instance); diff --git a/doc/example_architecture/last_chance_handler.adb b/doc/example_architecture/last_chance_handler.adb index b01616bf..0cfd2d78 100644 --- a/doc/example_architecture/last_chance_handler.adb +++ b/doc/example_architecture/last_chance_handler.adb @@ -1,4 +1,4 @@ --- Use the low level GNAT.IO package since the sytem is in a precarious state. +-- Use the low level GNAT.IO package since the system is in a precarious state. with GNAT.IO; with System.Storage_Elements; diff --git a/doc/example_architecture/oo_package/test/oo_package-tester.ads b/doc/example_architecture/oo_package/test/oo_package-tester.ads index 05ef7a78..18ccdc19 100644 --- a/doc/example_architecture/oo_package/test/oo_package-tester.ads +++ b/doc/example_architecture/oo_package/test/oo_package-tester.ads @@ -5,7 +5,7 @@ package Oo_Package.Tester is -- internal private variables during testing, even though you don't want this -- feature during the deployment of your software. -- - -- This function retreives the private value of "n" from within the object's + -- This function retrieves the private value of "n" from within the object's -- record and returns it. function Get_N (Self : in Instance) return Integer; diff --git a/doc/example_architecture/record_py/test.py b/doc/example_architecture/record_py/test.py index 6e87e695..4a8ca42f 100644 --- a/doc/example_architecture/record_py/test.py +++ b/doc/example_architecture/record_py/test.py @@ -1,13 +1,13 @@ #!/usr/bin/env python3 # Build our dependencies using the build system. -# This is necessary because some of the depdencies we +# This is necessary because some of the dependencies we # have are autogenerated. from util import pydep pydep.build_py_deps() -# Noe that the autocode has been built, import +# Now that the autocode has been built, import # the autocoded module. from example_record import Example_Record diff --git a/doc/example_architecture/record_register/main.adb b/doc/example_architecture/record_register/main.adb index db7bcc85..6e0ea0c5 100644 --- a/doc/example_architecture/record_register/main.adb +++ b/doc/example_architecture/record_register/main.adb @@ -18,7 +18,7 @@ begin -- Read and write register but only access certain components. The -- compiler will ensure that the ENTIRE register is read/written - -- during the folling operations. + -- during the following operations. if Reg.Hw_1_Enabled = Enable and then Reg.Hw_2_Enabled = Enable then Reg.Threshold := 22; end if; diff --git a/doc/example_architecture/record_register_set/main.adb b/doc/example_architecture/record_register_set/main.adb index 8ff5b434..43292ba6 100644 --- a/doc/example_architecture/record_register_set/main.adb +++ b/doc/example_architecture/record_register_set/main.adb @@ -19,7 +19,7 @@ begin -- Read and write registers but only access certain components. The -- compiler will ensure that the ENTIRE register is read/written - -- during the folling operations. + -- during the following operations. if Registers.Reg_2.Hw_1_Enabled = Enable and then Registers.Reg_3.Hw_2_Enabled = Enable then diff --git a/doc/example_architecture/science_assembly.assembly.yaml b/doc/example_architecture/science_assembly.assembly.yaml index 99ca5b82..6955fd02 100644 --- a/doc/example_architecture/science_assembly.assembly.yaml +++ b/doc/example_architecture/science_assembly.assembly.yaml @@ -48,8 +48,8 @@ components: # Optional - declare the base id for an ided entity # suite. If not declared, or a parameter is omitted, # then Adamant will automatically figure out the base - # id to use, selectin the lowest remaining ID - # avaialable. + # id to use, selecting the lowest remaining ID + # available. set_id_bases: - "data_Product_Id_Base => 100" # Required (only for components that have a data_dependencies diff --git a/doc/user_guide/user_guide.tex b/doc/user_guide/user_guide.tex index 7d119d0e..ecbcdbc2 100644 --- a/doc/user_guide/user_guide.tex +++ b/doc/user_guide/user_guide.tex @@ -294,7 +294,7 @@ \subsubsection{Project Configuration} \label{Project Configuration} You can now modify the values in \textit{adamant.configuration.yaml} to work for your project. Note that \textit{adamant.configuration.yaml} has been added to .gitignore, and should NOT be checked into your version control system if you intend on merging changes from your Adamant repository back into the framework root repository. -Version controlling the configuration file is usually desireable. To accomplish this, copy the Adamant default configuration into your project specific repository: +Version controlling the configuration file is usually desirable. To accomplish this, copy the Adamant default configuration into your project specific repository: \vspace{5mm} %5mm vertical space \begin{minted}{text} @@ -555,15 +555,15 @@ \subsubsection{The Build Target} \label{The Build Target} \end{spacedenumerate} \vspace{5mm} %5mm vertical space -The Ada compiler used in Adamant is generally GNAT based \texttt{gcc} for Native Linux compiles, and \texttt{gcc}-based cross compilers for embeddded targets (ie. \texttt{arm-eabi-gcc} for ARM). The compiler, compilation flags, and runtime are all determined by the \textit{build target}. The Adamant \textit{build path} determines which source code is compileable for a given \textit{build target} and is discussed in the following section. To add a custom build target for your system see Section \ref{Adding a Build Target} for details. \\ +The Ada compiler used in Adamant is generally GNAT based \texttt{gcc} for Native Linux compiles, and \texttt{gcc}-based cross compilers for embedded targets (ie. \texttt{arm-eabi-gcc} for ARM). The compiler, compilation flags, and runtime are all determined by the \textit{build target}. The Adamant \textit{build path} determines which source code is compilable for a given \textit{build target} and is discussed in the following section. To add a custom build target for your system see Section \ref{Adding a Build Target} for details. \\ As background, it is important to understand the Ada runtime system, on top of which an Ada application runs. The Ada runtime provides the tasking logic necessary to implement the Ada language. Adamant utilizes bare metal runtimes provided by AdaCore, which come in the following flavors: \vspace{5mm} %5mm vertical space \begin{spaceditemize} \item \textbf{\texttt{ZFP}} - The zero-footprint runtime only allows the non-tasking semantics of the Ada language. The resulting program must be single-threaded. This runtime is designed for formal software certification and/or for systems that are severely resource constrained. - \item \textbf{\texttt{SFP}} - The small footprint runtime implements a restricted subset of the Ada tasking system described by the Ravenscar profile. This runtime provides minimal tasking capabilities, without exception propogation, to make formal software certification feasible. - \item \textbf{\texttt{Full}} - The full runtime implements a restricted subset of the Ada tasking system described by the Jorvik profile. This profile is a slightly relaxed version of the Ravenscar profile, and allows exception propogation, designed for use on most embedded systems that do not require formal software certification. Note that the Jorvik profile is still very minimal compared to the full Ada language semantics which offers \texttt{select} statements, \texttt{rendezvous}, etc. These more flexible facilities are still not available in the Jorvik profile. + \item \textbf{\texttt{SFP}} - The small footprint runtime implements a restricted subset of the Ada tasking system described by the Ravenscar profile. This runtime provides minimal tasking capabilities, without exception propagation, to make formal software certification feasible. + \item \textbf{\texttt{Full}} - The full runtime implements a restricted subset of the Ada tasking system described by the Jorvik profile. This profile is a slightly relaxed version of the Ravenscar profile, and allows exception propagation, designed for use on most embedded systems that do not require formal software certification. Note that the Jorvik profile is still very minimal compared to the full Ada language semantics which offers \texttt{select} statements, \texttt{rendezvous}, etc. These more flexible facilities are still not available in the Jorvik profile. \end{spaceditemize} \vspace{5mm} %5mm vertical space @@ -586,7 +586,7 @@ \subsubsection{The Build Target} \label{The Build Target} Ada allows the configuration of runtime validity checks within the language. It is advisable to keep the default reference manual checks on in \textit{Production} mode to prevent any undefined behavior. In all other modes, all validity checking provided by GNAT is enabled. This provides much more extensive type checking than the default Ada checking, which can help track down hard to find bugs at the cost of extra code insertion into the binary. More information on validity checks within the Ada compiler can be found \href{https://gcc.gnu.org/onlinedocs/gcc-4.6.2/gnat_ugn_unw/Validity-Checking.html#Validity-Checking}{\textcolor{blue}{here}}. \\ -Ada also allows the user to restrict the use and behavior of the language by specifying configuration pragmas that apply to all the source code in the compilation. In \textit{Production}, \textit{Development}, and \textit{Debug} mode the Ravenscar profile is applied which restricts the tasking semantics allowed in the source code. This ensures that these builds will work with embedded runtimes, which support limited tasking semantics of the Ada language. Ravenscar is not enforced in \textit{Test} and \textit{Coverage} mode, to enabled more elaborate unit testing setups. All modes except \textit{Production} (*and \textit{Development} on bareboard targets) specify the pragma \texttt{Initialize\_Scalars}, which when used in conjunction with all validity checks enabled (\textit{-gnatVa}) can greatly aid in the detection of uninitialized variable bugs. Note that this pragma purposely initializes all unitialized variables to values outside the range for that type in order to force runtime errors for any variables that are used prior to initialization. See this \href{https://www.adacore.com/uploads/techPapers/rtchecks.pdf}{\textcolor{blue}{case study}} to explore the benefits of \texttt{Initialize\_Scalars} pragma. \\ +Ada also allows the user to restrict the use and behavior of the language by specifying configuration pragmas that apply to all the source code in the compilation. In \textit{Production}, \textit{Development}, and \textit{Debug} mode the Ravenscar profile is applied which restricts the tasking semantics allowed in the source code. This ensures that these builds will work with embedded runtimes, which support limited tasking semantics of the Ada language. Ravenscar is not enforced in \textit{Test} and \textit{Coverage} mode, to enabled more elaborate unit testing setups. All modes except \textit{Production} (*and \textit{Development} on bareboard targets) specify the pragma \texttt{Initialize\_Scalars}, which when used in conjunction with all validity checks enabled (\textit{-gnatVa}) can greatly aid in the detection of uninitialized variable bugs. Note that this pragma purposely initializes all uninitialized variables to values outside the range for that type in order to force runtime errors for any variables that are used prior to initialization. See this \href{https://www.adacore.com/uploads/techPapers/rtchecks.pdf}{\textcolor{blue}{case study}} to explore the benefits of \texttt{Initialize\_Scalars} pragma. \\ In summary, the \textit{Production} mode should be used for deployed software on target hardware. The \textit{Development} mode should be the most commonly used mode, as it should be preferred for most development and testing on target hardware. The \textit{Debug} mode turns off optimization of application and runtime code to make tracking down hard to find bugs easier. The \textit{Test} and \textit{Coverage} modes are designed for unit testing. These modes are an attempt at standardization of build configurations, but of course you can create a custom build target that does not adhere to any of these conventions. See Section \ref{Adding a Build Target} for details. \\ @@ -1055,7 +1055,7 @@ \subsubsection{Unit Test Logger} \label{Unit Test Logger} \inputminted{text}{../example_architecture/simple_package/test_better4/build/log/Test_That_Should_Pass.log} \vspace{5mm} %5mm vertical spac -The first test here is the passing test where all the messages are logged. Logs always appear in the form \textit{ } where \textit{} is Unix seconds. The user can log anything avaliable to them in the unit test, such as the individual items being tested. \\ +The first test here is the passing test where all the messages are logged. Logs always appear in the form \textit{ } where \textit{} is Unix seconds. The user can log anything available to them in the unit test, such as the individual items being tested. \\ The next test is the failure test, but this time there are no user defined messages injected into the log. Here we see the default messages that get logged including the timing for starting and finishing the test, as well as the setup and tear down fixtures. @@ -1064,11 +1064,11 @@ \subsubsection{Unit Test Logger} \label{Unit Test Logger} \inputminted{text}{../example_architecture/simple_package/test_better4/build/log/Test_That_Should_Fail.log} \vspace{5mm} %5mm vertical space -This is a simple but easy way for the user to mark where issues are occuring, or even print out their own data to the log for faster debugging of both the unit test code and the production code. +This is a simple but easy way for the user to mark where issues are occurring, or even print out their own data to the log for faster debugging of both the unit test code and the production code. \subsubsection{Unit Test Coverage Report} \label{Unit Test Coverage Report} -It is often desireable to know how much of the implementation code that a unit test actually tests. One metric for quantifying this is through a ``coverage" report, which shows which lines of code the unit tests traversed, and which lines of code were not not executed. For Adamant embedded systems, a 100\% line coverage metric is required, and justification must be provided if this goal cannot be achieved. Note that Adamant uses the \href{https://gcovr.com/en/stable/}{\textcolor{blue}{gcovr}} tool to generate reports. \\ +It is often desirable to know how much of the implementation code that a unit test actually tests. One metric for quantifying this is through a ``coverage" report, which shows which lines of code the unit tests traversed, and which lines of code were not not executed. For Adamant embedded systems, a 100\% line coverage metric is required, and justification must be provided if this goal cannot be achieved. Note that Adamant uses the \href{https://gcovr.com/en/stable/}{\textcolor{blue}{gcovr}} tool to generate reports. \\ Once we have a passing set of unit tests, creating a coverage report is not difficult. From the \textit{test\_better} directory created in the last section we can run: @@ -1166,7 +1166,7 @@ \subsubsection{Creating an Object-oriented Package} We can see that the package contains a tagged type named \texttt{Instance}. \textit{Instance} is the standard name used for a tagged type within Adamant when a package contains a single tagged type, which is common. \\ -Below the tagged type is two public subprograms, or ``primitives". These subprograms are considered primitive operations of the tagged type \texttt{Instance} because \texttt{Instance} is passed as an argument to them. Primitives are similiar to ``methods" in Java or a ``member functions" in C++. The first subprogram is a procedure called \texttt{Init} which initializes the object, which is always named \texttt{self} in Adamant. The second subprogram implements an adding function similiar to what was presented in the previous sections. This time, however, a private variable, \texttt{n}, stored within the tagged type record is added to the input argument instead. The variable \texttt{n} is part of the private definition of type \texttt{Instance} and thus cannot be accessed outside of the \texttt{Oo\_Package}, except within a child package, as we will see in the next section. +Below the tagged type is two public subprograms, or ``primitives". These subprograms are considered primitive operations of the tagged type \texttt{Instance} because \texttt{Instance} is passed as an argument to them. Primitives are similar to ``methods" in Java or a ``member functions" in C++. The first subprogram is a procedure called \texttt{Init} which initializes the object, which is always named \texttt{self} in Adamant. The second subprogram implements an adding function similar to what was presented in the previous sections. This time, however, a private variable, \texttt{n}, stored within the tagged type record is added to the input argument instead. The variable \texttt{n} is part of the private definition of type \texttt{Instance} and thus cannot be accessed outside of the \texttt{Oo\_Package}, except within a child package, as we will see in the next section. \subsubsection{``White-box" Unit Testing} @@ -1888,7 +1888,7 @@ \subsubsection{Enumeration MATLAB Class} \textit{Second\_Enum.m} \matlabcodef{../example_architecture/build/m/Example_Enums/Second_Enum.m} -The MATLAB classs contain the numeric definitions for each of the enumeration literals. +The MATLAB class contain the numeric definitions for each of the enumeration literals. An example of how these classes can be used is shown below in a file called \textit{test.m}: @@ -2041,7 +2041,7 @@ \section{Components} \label{Components} \end{itemize} \vspace{5mm} %5mm vertical space -Each pattern builds on the previous pattern. It is recommended that for best understanding of an active component with queue to first read the sections for a passive component without queue followed by a passive component with queue, before proceding to the active component with queue section. +Each pattern builds on the previous pattern. It is recommended that for best understanding of an active component with queue to first read the sections for a passive component without queue followed by a passive component with queue, before proceeding to the active component with queue section. \subsection{Creating a Passive Component} \label{Creating a Passive Component} @@ -2103,7 +2103,7 @@ \subsection{Creating a Passive Component} \label{Creating a Passive Component} The chosen connector \textit{kind} pair determines whether or not a \textit{type}, \textit{return\_type}, or both is required for the connector definition. Note that a model error will be produced if you fail to comply with the table above, so have no fear of making mistakes. \\ -The definition of the \texttt{Packet\_T\_Send} connector specifies the optional field \textit{count}. The \textit{count} field is used to specify an \textit{arrayed} connector. When not specified, the connector \textit{count} is assumed to be 1, which means that the connector is not arrayed. If a positive value greated than 1 is provided, then the component is created with an array of connectors of the specified size. If the \textit{count} is defined as 0, as is the case here, than the connector array size is said to be \textit{unconstrained} and will be set during the component's instantiation within an assembly, see Section \ref{Assemblies}. In this case we have created an unconstrained array of \texttt{Packed.T} \textit{send} connectors, which can be called by index. \\ +The definition of the \texttt{Packet\_T\_Send} connector specifies the optional field \textit{count}. The \textit{count} field is used to specify an \textit{arrayed} connector. When not specified, the connector \textit{count} is assumed to be 1, which means that the connector is not arrayed. If a positive value greater than 1 is provided, then the component is created with an array of connectors of the specified size. If the \textit{count} is defined as 0, as is the case here, than the connector array size is said to be \textit{unconstrained} and will be set during the component's instantiation within an assembly, see Section \ref{Assemblies}. In this case we have created an unconstrained array of \texttt{Packed.T} \textit{send} connectors, which can be called by index. \\ Note that we have defined an optional \textit{name} for the \texttt{Tick\_T\_Recv\_Sync} connector. If no \textit{name} is specified then Adamant will generate a name for the connector in the form \textit{type\_kind} where \textit{type} is the connector type with any ``."s replaced by ``\_"s and \textit{kind} is the connector's \textit{kind}. In general, it is considered good practice to NOT provide names for connectors, as the autocoded names are informative and follow a convention that provides information about of the connector's form and function. However, there are certainly exceptions to this rule. Sometimes defining a custom name makes more sense, like in the case where a component has two connectors of the same \textit{type} that perform distinct behaviors. \\ @@ -2559,7 +2559,7 @@ \subsubsection{Component Unit Test Logger} \label{Component Unit Test Logger} \inputminted{text}{../example_architecture/example_component/test4/build/log/Test_That_Should_Fail.log} \vspace{5mm} %5mm vertical space -And the passing test has none of our injected log messages, but there is still default logging occuring from all of the interfaces being used during the test. +And the passing test has none of our injected log messages, but there is still default logging occurring from all of the interfaces being used during the test. \vspace{5mm} %5mm vertical space \textit{build/log/Test\_That\_Should\_Fail.log} @@ -2868,7 +2868,7 @@ \subsubsection{Unit Testing a Queued Component} \label{Unit Testing a Queued Com \subsubsection{Implementing a Priority Queued Component} \label{Implementing a Priority Queued Component} -The previous sections presented how to construct and unit test a component that contains a standard internal queue. The Adamant standard queue is a very efficient (in both space and time) first-in-first-out FIFO queue. However, sometimes it is desireable to have a queue that implements priority-based dequeueing logic instead of FIFO. Priority queues allow the component to process messages deemed more important prior to servicing others, regardless of the order in which they were enqueued. \\ +The previous sections presented how to construct and unit test a component that contains a standard internal queue. The Adamant standard queue is a very efficient (in both space and time) first-in-first-out FIFO queue. However, sometimes it is desirable to have a queue that implements priority-based dequeueing logic instead of FIFO. Priority queues allow the component to process messages deemed more important prior to servicing others, regardless of the order in which they were enqueued. \\ A few implementation differences between the Adamant standard queue and the priority queue should be understood. The standard queue is implemented as a single buffer of memory where queued items are stored efficiently, packed together, with no wasted bytes. As such, initializing the standard queue requires that the user specify the total number of bytes the queue should contain. The priority queue does not make as efficient use of memory. Each element on the priority queue takes up the number of bytes necessary to hold the maximum sized element that the queue will need to hold. So if two different types need to be stored on the queue, one takes up 5 bytes and another takes up 500 bytes, each element on the queue will be 500 bytes in length. Enqueuing the 5 byte item will leave 495 bytes unused in that queue entry. Instead of initializing the queue as a total number of bytes, a priority queue is initialized with a \textit{depth} which specifies how many entries of maximum size the queue will hold before beginning to drop items. \\ @@ -2982,7 +2982,7 @@ \subsubsection{Implementing an Active Component} \textit{component-active\_component-implementation.adb}: \adacodef{../example_architecture/active_component/component-active_component-implementation.adb} -We can see that the implementations of \texttt{Packed\_Byte\_T\_Recv\_Async} and \texttt{Packed\_U16\_T\_Recv\_Async} are very similiar. Any time an item is popped off the component's queue one of these handlers is called. A packet is then created containing the data item and sent out of the component. The \texttt{Packed\_Byte\_T\_Recv\_Async\_Dropped} and \texttt{Packed\_U16\_T\_Recv\_Async\_Dropped} subprograms are implemented in the same fashion as in Section \ref{Implementing a Queued Component} and will get called if the component queue ever becomes too full to hold another item. \\ +We can see that the implementations of \texttt{Packed\_Byte\_T\_Recv\_Async} and \texttt{Packed\_U16\_T\_Recv\_Async} are very similar. Any time an item is popped off the component's queue one of these handlers is called. A packet is then created containing the data item and sent out of the component. The \texttt{Packed\_Byte\_T\_Recv\_Async\_Dropped} and \texttt{Packed\_U16\_T\_Recv\_Async\_Dropped} subprograms are implemented in the same fashion as in Section \ref{Implementing a Queued Component} and will get called if the component queue ever becomes too full to hold another item. \\ We can make sure that this code compiles by running: @@ -3922,7 +3922,7 @@ \subsubsection{Fetching Data Dependencies} Besides the \texttt{Invalid\_Data\_Dependency} procedure, which just prints out an error message if an invalid data dependency is received, the only subprogram included is the \texttt{Tick.T} connector handler. This would likely be tied to a rate group and get called periodically in a running assembly. The implementation of the handler does two things: 1) It grabs the \texttt{Counter} data dependency and reports its value via a print message, and 2) It grabs the \texttt{Temperature} data dependency and checks it against a static limit if it is both valid. Both data dependencies are also checked to make sure they are not stale. \\ -The \texttt{Counter} data dependency and its corresponding timestamp is requested via the \texttt{Get\_Counter} function. Note that the return status of this function should be checked prior to using the returned counter value, as it may not be valid. If \texttt{Success} is returned, then the counter is valid and can be used. If \texttt{Not\_Available} is returned, then there is not corresponding data product available yet in the central store to relate the value of the counter. In this case, the returned value for \texttt{cnt} should not be used. If \texttt{Stale} is returned then the data dependency's timstamp was older than the \texttt{stale\_Reference} (the current time in this case) minus the data dependency's \textit{stale limit}. Using a data dependency that is stale can be problematic, and should be avoided. Finally, if \texttt{Error} is returned, then something unexpected happened, and you should also not use \texttt{cnt}. Note that an \texttt{Error} return value will only be returned after a call to \texttt{Invalid\_Data\_Dependency} has been made by the base package. In this way, the component developer can encapsulate all error handling for invalid data dependencies in this single subprogram. \\ +The \texttt{Counter} data dependency and its corresponding timestamp is requested via the \texttt{Get\_Counter} function. Note that the return status of this function should be checked prior to using the returned counter value, as it may not be valid. If \texttt{Success} is returned, then the counter is valid and can be used. If \texttt{Not\_Available} is returned, then there is not corresponding data product available yet in the central store to relate the value of the counter. In this case, the returned value for \texttt{cnt} should not be used. If \texttt{Stale} is returned then the data dependency's timestamp was older than the \texttt{stale\_Reference} (the current time in this case) minus the data dependency's \textit{stale limit}. Using a data dependency that is stale can be problematic, and should be avoided. Finally, if \texttt{Error} is returned, then something unexpected happened, and you should also not use \texttt{cnt}. Note that an \texttt{Error} return value will only be returned after a call to \texttt{Invalid\_Data\_Dependency} has been made by the base package. In this way, the component developer can encapsulate all error handling for invalid data dependencies in this single subprogram. \\ The \texttt{Temperature} data dependency is requested via the \texttt{Get\_Temperature} function and is checked in a similar fashion. The next section will describe how to unit test component that uses data dependencies. \\ @@ -4222,7 +4222,7 @@ \subsubsection{Creating a Command Model} First, we can see that there is a \texttt{Instance} type, which is the command suite tagged type. There is also a public \texttt{local\_command\_Id\_Type} enumeration which declares the \textit{local IDs} for the commands. When instantiated in a component, these local IDs will be added to the component's \textit{command ID base}. The command ID base can be set through the public function \texttt{set\_Id\_Base} which is called during component initialization, see Section \ref{Component Set ID Bases}. Note that the ID base for the command suite is stored in the \texttt{Instance} record in the private section in the \texttt{id\_Base} variable. \\ -Also stored in the \texttt{Instance} record is a \texttt{source\_Id} variable. This variable can be set or retrieved through the \texttt{set\_Source\_Id} and \texttt{get\_Source\_Id} subprograms. The \texttt{Source\_Id} get's populated in the command header and signifies where the command is originating from. This value is generally not used by the component executing command, but is used by the Adamant standard command routing and command response forwarding system provided by the Command Router component, see \textit{src/components/command\_router}. \\ +Also stored in the \texttt{Instance} record is a \texttt{source\_Id} variable. This variable can be set or retrieved through the \texttt{set\_Source\_Id} and \texttt{get\_Source\_Id} subprograms. The \texttt{Source\_Id} gets populated in the command header and signifies where the command is originating from. This value is generally not used by the component executing command, but is used by the Adamant standard command routing and command response forwarding system provided by the Command Router component, see \textit{src/components/command\_router}. \\ Next, there is a set of two functions which return the ID for each command in the command suite. The returned ID will already have the ID base offset applied to the local ID. Finally, there is a set of two functions that are used to create the two commands. \\ @@ -4419,7 +4419,7 @@ \subsubsection{Updating and Using Parameters} \end{spaceditemize} \vspace{5mm} %5mm vertical space -The \texttt{Fetch} operation is the most straightfoward. The current \textit{staged} value of the parameter is simply returned to the caller. The \texttt{Stage} and \texttt{Update} operations are a bit more sophisticated and are described further. \\ +The \texttt{Fetch} operation is the most straightforward. The current \textit{staged} value of the parameter is simply returned to the caller. The \texttt{Stage} and \texttt{Update} operations are a bit more sophisticated and are described further. \\ When a parameter \texttt{Stage} operation is received by a component, the component base package does the following: @@ -4451,7 +4451,7 @@ \subsubsection{Updating and Using Parameters} \textit{component-parameter\_component-implementation.adb}: \adacodef{../example_architecture/parameter_component/component-parameter_component-implementation.adb} -The first thing to notice is the implementation of the \texttt{Parameter\_Update\_T\_Modify} connector handler. This code is completely generated by the template autocoder, and rarely needs to be modified by the developer. It calls \texttt{Process\_Parameter\_Update} which is an autocoded procedure in the base package that performs the procedure described above, processing the paramter update based on the specified \texttt{Operation}. Returned from this call is the parameter status which is returned to the connector caller (via \texttt{in out} procedure parameter). \\ +The first thing to notice is the implementation of the \texttt{Parameter\_Update\_T\_Modify} connector handler. This code is completely generated by the template autocoder, and rarely needs to be modified by the developer. It calls \texttt{Process\_Parameter\_Update} which is an autocoded procedure in the base package that performs the procedure described above, processing the parameter update based on the specified \texttt{Operation}. Returned from this call is the parameter status which is returned to the connector caller (via \texttt{in out} procedure parameter). \\ The next procedure, \texttt{Tick\_T\_Recv\_Sync} represents the main execution of the component. In this procedure, we first call \texttt{Self.Update\_Parameters}, which is implemented in the component base package. As described earlier, if all the parameters for the component have been staged through calls to \texttt{Parameter\_Update\_T\_Modify} from an external component (as indicated by the \texttt{Update} operation), then this function will atomically copy those staged parameters to their working copies in the component \texttt{Instance} record. If an \texttt{Update} has not yet been received, then the call to \texttt{Update\_Parameters} does nothing and returns instantly. \\ @@ -4886,7 +4886,7 @@ \subsubsection{Generic Components} The new tag here is \texttt{generic\_types}, which contains a list of the generic parameter names and the types to instantiate them with. Similar to the \texttt{init\_base} tag, all \texttt{generic\_types} must be listed as id-value pairs of the form ``\texttt{generic\_Parameter\_Name => Type}". What we have done here is turned our generic \textit{splitter} into a splitter specialized for splitting events. We can easily define a few more splitters in our assembly model for any other type we wish to split. This is the power of generic components. \\ -Note that special care needs to be taken when defining a generic connector type that is of kind \textit{recv\_async}. This implies that the generic type will get serialized onto the component's internal queue. Usually in Adamant, if an \textit{recv\_async} connector is called, the type gets serialized onto the component's internal queue. If the type is a packed record of variable length, then only the bytes used in the type (usually specified by a length field in a header) will be serialized onto the queue. The same behavior is not implemented by default when using a generic type on a \textit{recv\_async} connector. By default, the maximum size of the generic type will always get serialized onto the queue. The reason for this is that the component has no way of determining the serialized length of the type, unless you explicitely provide a way. \\ +Note that special care needs to be taken when defining a generic connector type that is of kind \textit{recv\_async}. This implies that the generic type will get serialized onto the component's internal queue. Usually in Adamant, if an \textit{recv\_async} connector is called, the type gets serialized onto the component's internal queue. If the type is a packed record of variable length, then only the bytes used in the type (usually specified by a length field in a header) will be serialized onto the queue. The same behavior is not implemented by default when using a generic type on a \textit{recv\_async} connector. By default, the maximum size of the generic type will always get serialized onto the queue. The reason for this is that the component has no way of determining the serialized length of the type, unless you explicitly provide a way. \\ For example, if a component with a generic \textit{recv\_async} connector is instantiated with the type \texttt{Command.T}, then every time a command is received by the component, the maximum size of the \texttt{Command.T} type is serialized onto the queue. To get around this behavior and allow the intelligent serialization of variable length types you MUST include an additional formal parameter in your \texttt{generic} definition in the component model named \texttt{Serialized\_Length}, which provides a function that returns the serialized length of the packed record. The definition should look like the example shown below: @@ -4908,14 +4908,14 @@ \subsubsection{Generic Components} When the Adamant system sees a \texttt{Serialized\_Length} function provided in the generic formal parameter list, it will automatically include the autocoded logic to intelligently serialized variable length types onto the component's internal queue. Note that all packed records defined in Adamant, whether they are variable length or not, include a \texttt{Serialized\_Length} function which fits the definition shown above. Thus this generic formal definition can be used to instantiate the component with static sized or variable length packed records alike. The underlying autocoded base package will handle both cases correctly. \\ -For an example of this pattern see the \textit{Limiter} component found in \textit{src/components/generics/limiter}. The component contains unit tests that excersize the component's asynchronous connector instantiated with both a staticly sized and variable length packed record. +For an example of this pattern see the \textit{Limiter} component found in \textit{src/components/generics/limiter}. The component contains unit tests that exercise the component's asynchronous connector instantiated with both a statically sized and variable length packed record. \subsubsection{Component Interrupt Handling} \label{Component Interrupt Handling} Adamant provides modeling support for any component that directly handles interrupts. Interrupt specific parameters such as the interrupt priority and ID are often set via the \textit{discriminant} in Ada. Indeed, you could simply use the \textit{discrimininant} tag in your component model to pass in this interrupt data, see Section \ref{Component Instantiation} but then the Adamant modeling system would not know about the interrupt. By providing a way to specify interrupts directly within a component model we are able to more readily produce documentation and other useful autocode associated with all the interrupts in the system. So if you need to handle and interrupt in your component, using the feature presented in this section is highly recommended. \\ -Most interrupt handling in Adamant can be achieved by using the components found in \textit{src/components/interrupt\_handlers}. Sometimes you need to handle interrupts in a particular way that these components cannot accomodate, and thus you need to define an interrupt handling component from scratch. In this case, using the Adamant interrupt handling components will serve as good examples. In fact, we will use the Adamant \textit{interrupt\_servicer} component to demonstrate the interrupt feature in this section. \\ +Most interrupt handling in Adamant can be achieved by using the components found in \textit{src/components/interrupt\_handlers}. Sometimes you need to handle interrupts in a particular way that these components cannot accommodate, and thus you need to define an interrupt handling component from scratch. In this case, using the Adamant interrupt handling components will serve as good examples. In fact, we will use the Adamant \textit{interrupt\_servicer} component to demonstrate the interrupt feature in this section. \\ Let's take a look at the interrupt servicer component model which can be found in \textit{src/components/interrupt\_handlers/interrupt\_servicer/}: \\ @@ -4931,7 +4931,7 @@ \subsubsection{Component Interrupt Handling} \label{Component Interrupt Handling \textit{component-interrupt\_servicer-implementation.ads:} \adacodef{../../src/components/interrupt_servicer/component-interrupt_servicer-implementation.ads} -As can be seen in the component \texttt{Instance} definition, the discriminant not only consists of the \texttt{discriminant} parameter defined in the model, \texttt{custom\_Interrupt\_Procedure}, it also has two additional parameters, \texttt{interrupt\_Id} and \texttt{interrupt\_Priority}. The second two parameters are inserted automatically due to the \texttt{interrupt} definition in the component model. We can see that these two parameters are used to instantiate a \texttt{Task\_Signal} object in the component record, whose definition can be found in the Adamant core interrupt handlers packege, \textit{src/core/interrupt\_handlers}. You should consider using, or adding to, this package if you are defining a custom interrupt handling component in your system. \\ +As can be seen in the component \texttt{Instance} definition, the discriminant not only consists of the \texttt{discriminant} parameter defined in the model, \texttt{custom\_Interrupt\_Procedure}, it also has two additional parameters, \texttt{interrupt\_Id} and \texttt{interrupt\_Priority}. The second two parameters are inserted automatically due to the \texttt{interrupt} definition in the component model. We can see that these two parameters are used to instantiate a \texttt{Task\_Signal} object in the component record, whose definition can be found in the Adamant core interrupt handlers package, \textit{src/core/interrupt\_handlers}. You should consider using, or adding to, this package if you are defining a custom interrupt handling component in your system. \\ Instantiating a component with interrupts in the assembly model is no different than instantiating any other component with \texttt{discriminant} parameters defined. An example is shown below. @@ -5032,9 +5032,9 @@ \subsubsection{Assembly-parameterized Components} \newpage \section{Assemblies} \label{Assemblies} -In Adamant, an \textit{assembly} is a collection of components that have been connected together to form an executable deployment of sofware. Assemblies are lightweight, modeled constructs that can be used for a variety of purposes. Often when developing software with Adamant you will develop a multitude of assemblies. You may have an assembly that contains a configuration of components that perform an early demonstration test of your system. You may have an assembly specially tuned to test a single piece of hardware. You may have an assembly that only executes in a simulation environment on a desktop PC. Finally, you will almost certainly have a production assembly that is used to construct the target sofware for your project. \\ +In Adamant, an \textit{assembly} is a collection of components that have been connected together to form an executable deployment of software. Assemblies are lightweight, modeled constructs that can be used for a variety of purposes. Often when developing software with Adamant you will develop a multitude of assemblies. You may have an assembly that contains a configuration of components that perform an early demonstration test of your system. You may have an assembly specially tuned to test a single piece of hardware. You may have an assembly that only executes in a simulation environment on a desktop PC. Finally, you will almost certainly have a production assembly that is used to construct the target software for your project. \\ -The component-based principles of Adamant make constructing different assemblies of components for different purposes straightfoward. Because components are loosely coupled, they can easily be swapped and rearranged as necessary to create differently functioning software while reusing the code found in common core components. \\ +The component-based principles of Adamant make constructing different assemblies of components for different purposes straightforward. Because components are loosely coupled, they can easily be swapped and rearranged as necessary to create differently functioning software while reusing the code found in common core components. \\ This section demonstrates how to construct an assembly and use it to produce integrated software made up of a set of loosely coupled components. This section also presents diagram and documentation generation, integration with a ``ground" system, integration-level testing, and more. @@ -5957,9 +5957,9 @@ \subsubsection{Hydra Integration} \textit{Note that Hydra is not yet publicly available, but will be made so in the future.} -Adamant provides support for interfacing with Hydra at the assembly level. Specifically, any assembly can be controlled by Hydra via commands and recieve data from the Adamant system through data products and packets. \\ +Adamant provides support for interfacing with Hydra at the assembly level. Specifically, any assembly can be controlled by Hydra via commands and receive data from the Adamant system through data products and packets. \\ -Hydra is configured via special XML files. Many of these files can be generated from an Adamant assembly model. To see what is available we can run \texttt{redo what} from an assemnbly directory. For example, we can run this from the \textit{science\_assembly} directory created in previous sections (some output ommitted for brevity): +Hydra is configured via special XML files. Many of these files can be generated from an Adamant assembly model. To see what is available we can run \texttt{redo what} from an assemnbly directory. For example, we can run this from the \textit{science\_assembly} directory created in previous sections (some output omitted for brevity): \vspace{5mm} %5mm vertical space \begin{minted}{text} @@ -6111,7 +6111,7 @@ \subsection{Coding Style} \label{Coding Style} A coding style is a set of rules or guidelines used when writing the source code for a program. The rules generally pertain to the visual appearance of the code and the aim is to improve uniformity in the ``look" of the code. Once developers become accustomed to a particular coding style, they can more easily read and understand source code written in that style. Adamant enforces a coding style for all Ada, Python, and YAML to enforce consistency and improve understandability. \\ -The main tool for enforcing style is \texttt{redo style}. When run, this will check any Ada, Python, YAML, or autocoded Ada, Python, or YAML and ensure that the style guidlines are met. The following example is run in \textit{doc/example\_architecture/style\_demo}. Which includes the following poorly written code: \\ +The main tool for enforcing style is \texttt{redo style}. When run, this will check any Ada, Python, YAML, or autocoded Ada, Python, or YAML and ensure that the style guidelines are met. The following example is run in \textit{doc/example\_architecture/style\_demo}. Which includes the following poorly written code: \\ \textit{main.adb}: \adacodef{../example_architecture/style_demo/main.adb} @@ -6481,7 +6481,7 @@ \subsection{Creating a Register Map} \label{Creating a Register Map} This is not the normal output we expect to see when generating an Ada package. However, the register map produced is special in that it is written mostly in SPARK, the formally provable subset of Ada. \texttt{GNATprove} is then automatically run to statically check the output, which is shown above. \\ -The primary reason for this is that SPARK disallows the definition of bit-constrained types with address clauses. A bit-constrained type is a type that for some bit value can become invalid, causing a \texttt{Contraint\_Error} to be thrown at runtime. While bit-constrained types are useful for catching bugs in most Ada code, they can be troublesome when interfacing with volatile hardware interfaces, where the compiler is not in control of what might be written to these types. In such cases, a hardware interface may write an invalid bit value to a type within a register map. When this type is later read by the Ada program, a \texttt{Contraint\_Error} will be thrown. To prevent this, Adamant does not allow bit-constrained types to be defined in register maps. To enforce this it uses the SPARK programming language. If bit-constrained types are used in the register map than an error will produced and the specification will not be generated. \\ +The primary reason for this is that SPARK disallows the definition of bit-constrained types with address clauses. A bit-constrained type is a type that for some bit value can become invalid, causing a \texttt{Constraint\_Error} to be thrown at runtime. While bit-constrained types are useful for catching bugs in most Ada code, they can be troublesome when interfacing with volatile hardware interfaces, where the compiler is not in control of what might be written to these types. In such cases, a hardware interface may write an invalid bit value to a type within a register map. When this type is later read by the Ada program, a \texttt{Constraint\_Error} will be thrown. To prevent this, Adamant does not allow bit-constrained types to be defined in register maps. To enforce this it uses the SPARK programming language. If bit-constrained types are used in the register map than an error will produced and the specification will not be generated. \\ The generated specification files is shown below: \\ @@ -6506,7 +6506,7 @@ \subsection{Creating a Register Map} \label{Creating a Register Map} \subsection{Creating a Memory Map} \label{Creating a Memory Map} -A \textit{memory map} in Adamant is similar to a \textit{register map}, discussed in Section \ref{Creating a Register Map}, however, instead of defining the address for each item individually, items are layed out contiguously (packed tightly) at a given starting address. The common use case for a \textit{memory map} is when defining a set of data that needs to be saved in nonvolatile memory located at a specific hardware address. \\ +A \textit{memory map} in Adamant is similar to a \textit{register map}, discussed in Section \ref{Creating a Register Map}, however, instead of defining the address for each item individually, items are laid out contiguously (packed tightly) at a given starting address. The common use case for a \textit{memory map} is when defining a set of data that needs to be saved in nonvolatile memory located at a specific hardware address. \\ Often in embedded systems, data needs to be stored persistently, across reboots. This data is usually stored in some kind of nonvolatile memory, such as MRAM, commonly without aid of a file system. In such a case, important variables are stored at predetermined static addresses. In Adamant, we refer to this as a \textit{memory map}. \\ @@ -6550,7 +6550,7 @@ \subsection{Creating a Memory Map} \label{Creating a Memory Map} This is not the normal output we expect to see when generating an Ada package. However, the memory map produced is special in that it is written mostly in SPARK, the formally provable subset of Ada. \texttt{GNATprove} is then automatically run to statically check the output, which is shown above. \\ -The primary reason for this is that SPARK disallows the definition of bit-constrained types with address clauses. A bit-constrained type is a type that for some bit value can become invalid, causing a \texttt{Contraint\_Error} to be thrown at runtime. While bit-constrained types are useful for catching bugs in most Ada code, they can be troublesome when interfacing with volatile hardware interfaces, where the compiler is not in control of what might be written to these types. In such cases, a hardware interface may write an invalid bit value to a type within a memory map. When this type is later read by the Ada program, a \texttt{Contraint\_Error} will be thrown. To prevent this, Adamant does not allow bit-constrained types to be defined in memory maps. To enforce this it uses the SPARK programming language. If bit-constrained types are used in the register map than an error will produced and the specification will not be generated. \\ +The primary reason for this is that SPARK disallows the definition of bit-constrained types with address clauses. A bit-constrained type is a type that for some bit value can become invalid, causing a \texttt{Constraint\_Error} to be thrown at runtime. While bit-constrained types are useful for catching bugs in most Ada code, they can be troublesome when interfacing with volatile hardware interfaces, where the compiler is not in control of what might be written to these types. In such cases, a hardware interface may write an invalid bit value to a type within a memory map. When this type is later read by the Ada program, a \texttt{Constraint\_Error} will be thrown. To prevent this, Adamant does not allow bit-constrained types to be defined in memory maps. To enforce this it uses the SPARK programming language. If bit-constrained types are used in the register map than an error will produced and the specification will not be generated. \\ The generated specification files is shown below: \\ diff --git a/env/provision/requirements1.txt b/env/provision/requirements1.txt index a92aaa3a..63b433c8 100644 --- a/env/provision/requirements1.txt +++ b/env/provision/requirements1.txt @@ -15,3 +15,4 @@ Pygments matplotlib flake8 black +codespell diff --git a/gen/generators/basic.py b/gen/generators/basic.py index 536ce848..4c640160 100644 --- a/gen/generators/basic.py +++ b/gen/generators/basic.py @@ -48,7 +48,7 @@ def init_func(self): ) -# Add a class to a specific module. By defualt, calling this will add the generator to +# Add a class to a specific module. By default, calling this will add the generator to # the module you called the function from. def add_class_to_module(cls, module=globals()): module[cls.__name__] = cls diff --git a/gen/generators/memory_map.py b/gen/generators/memory_map.py index 820c1f14..27f428eb 100644 --- a/gen/generators/memory_map.py +++ b/gen/generators/memory_map.py @@ -83,7 +83,7 @@ def generate(self, input_filename, methods_to_call_on_model_obj=[]): old_target, ) - # Exit early if error occured: + # Exit early if error occurred: if ret != 0: error.error_print( "Analyzing generated map " + output_filename + " with GNATprove failed." diff --git a/gen/generators/packed_types.py b/gen/generators/packed_types.py index 6a43b081..91e5a1cc 100644 --- a/gen/generators/packed_types.py +++ b/gen/generators/packed_types.py @@ -105,7 +105,7 @@ def output_filename(self, input_filename): def generate(self, input_filename, methods_to_call_on_model_obj=[]): # - # This is a uniqe generator in that in takes a single input a name.enums.yaml + # This is a unique generator in that in takes a single input a name.enums.yaml # and produces multiple outputs. The target will be a directory in build/m/name # that contains a .m file for eacn enumeration defined in name.enums.yaml. The # reason for this is that matlab only allows a single class definition per file diff --git a/gen/models/base.py b/gen/models/base.py index 435eeb5b..331489df 100644 --- a/gen/models/base.py +++ b/gen/models/base.py @@ -91,7 +91,7 @@ def render(self, template_file, template_path=None): # inherit from this class. class base(renderable_object, metaclass=abc.ABCMeta): ################################################# - # Model Cacheing: + # Model Caching: ################################################# def load_from_cache(cls, filename): @@ -238,7 +238,7 @@ def validate(self): c.validate(raise_exception=True) except BaseException as e: raise ModelException( - "Error occured while validating " + "Error occurred while validating " + self.full_filename + " against " + self.full_schema diff --git a/gen/models/component.py b/gen/models/component.py index 8587db30..dc3c3124 100644 --- a/gen/models/component.py +++ b/gen/models/component.py @@ -321,7 +321,7 @@ def load(self): ] ) - # We have a naming requirement that any entity in an ided entity submodel must have a uniqe name. Ie. A command + # We have a naming requirement that any entity in an ided entity submodel must have a unique name. Ie. A command # for a component cannot have the same name as an event for that component. This creates problems with Hydra and # sometimes with Ada compilation. To keep things simple, we do not allow this to happen. entity_names = [] diff --git a/gen/models/exceptions.py b/gen/models/exceptions.py index de937f1e..77a6ca69 100644 --- a/gen/models/exceptions.py +++ b/gen/models/exceptions.py @@ -33,9 +33,9 @@ def inner(*args, **kwargs): return inner -# Decorator which catches a model exception and addes +# Decorator which catches a model exception and adds # a line number if the argument of the function contains -# an attribue "lc.line" which is the line number attribute +# an attribute "lc.line" which is the line number attribute # of a round trip loaded yaml dictionary from ruamel.yaml def throw_exception_with_lineno(func): def inner(*args, **kwargs): diff --git a/gen/models/record.py b/gen/models/record.py index 8d0c7740..a1f56fb6 100644 --- a/gen/models/record.py +++ b/gen/models/record.py @@ -477,7 +477,7 @@ def flattened_names_seq(self, prefix=""): names.append(a_field.name) return names - # This funcion will create a graph of all of the child fields of whatever data_product is calling it + # This function will create a graph of all of the child fields of whatever data_product is calling it # This function returns a dictionary in the form of: # { # "paths" : [[]], diff --git a/gen/models/submodels/field.py b/gen/models/submodels/field.py index bfc0a0e0..97a6169d 100644 --- a/gen/models/submodels/field.py +++ b/gen/models/submodels/field.py @@ -396,7 +396,7 @@ def is_always_valid(self): # This is not a packed type, determine if type is valid based on size in bits. else: # The caller to this function must have already loaded the type ranges for this type, otherwise - # the ranges wont be available for the comparison below. + # the ranges won't be available for the comparison below. assert self.type_ranges_loaded, ( "This should be True for '" + str(self.name) diff --git a/gen/models/submodels/interrupts.py b/gen/models/submodels/interrupts.py index 2f4ca6ea..1a6b59ea 100644 --- a/gen/models/submodels/interrupts.py +++ b/gen/models/submodels/interrupts.py @@ -93,7 +93,7 @@ def names(self): def set_ids_and_priorities(self, discriminant_obj, component_name): # Resolve all interrupt ids and priorities with the discriminant object: for interrupt in self.list: - # Get the priority and id parameters from the descriminant: + # Get the priority and id parameters from the discriminant: priority_param = discriminant_obj.get_parameter( interrupt.priority_parameter_name ) diff --git a/gen/models/submodels/tasks.py b/gen/models/submodels/tasks.py index 4e3dcdbd..1a2f72ab 100644 --- a/gen/models/submodels/tasks.py +++ b/gen/models/submodels/tasks.py @@ -195,7 +195,7 @@ def set_instance_data( + component_name + " requires the following subtask initializations: " + str(list(self.subtask_names)) - + " but these initialzations were provided: " + + " but these initializations were provided: " + str(subtask_names) ) diff --git a/gen/models/tests.py b/gen/models/tests.py index 86eb5a08..5d0078dd 100644 --- a/gen/models/tests.py +++ b/gen/models/tests.py @@ -81,7 +81,7 @@ def load_component(self): # Do base class load: component_submodel.load_component(self) except ModelException: - # If this occured, then this unit test is likely not a component + # If this occurred, then this unit test is likely not a component # unit test, so just continue on. We want self.component to be None # in this case. pass diff --git a/gen/schemas/analyze.yaml b/gen/schemas/analyze.yaml index 3b8bdb6a..cee818d5 100644 --- a/gen/schemas/analyze.yaml +++ b/gen/schemas/analyze.yaml @@ -16,7 +16,7 @@ mapping: # "level" sets the level of analysis, which impacts both time and accuracy. Note that messages # for lower levels are not necessarily a subset of those for higher levels. # - # The default level is 2 and can be overriden via the "level" field. + # The default level is 2 and can be overridden via the "level" field. # # Level Description # diff --git a/gen/schemas/assembly.yaml b/gen/schemas/assembly.yaml index 46c64e65..b040551c 100644 --- a/gen/schemas/assembly.yaml +++ b/gen/schemas/assembly.yaml @@ -39,7 +39,7 @@ mapping: # # Make sure subassemblies are in the build path or an error will result. # Subassemblies can be used to split up large assembly files into smaller, - # more managable files. This can facilitate reuse and ease assembly + # more manageable files. This can facilitate reuse and ease assembly # maintenance. subassemblies: seq: @@ -106,7 +106,7 @@ mapping: seq: - type: str required: False - # If the component has values to fill in for the descriminant they should be + # If the component has values to fill in for the discriminant they should be # listed here as name value pairs, ie. # "Name => Value" discriminant: diff --git a/gen/schemas/faults.yaml b/gen/schemas/faults.yaml index 8fba78e9..de4c5dca 100644 --- a/gen/schemas/faults.yaml +++ b/gen/schemas/faults.yaml @@ -21,7 +21,7 @@ mapping: required: False # Identifier for the fault. This is optional, but if provided for one # fault, must be provided for all faults. If not provided then faults - # IDs will be set via the Set_Id_Base initialization funciton. If IDs + # IDs will be set via the Set_Id_Base initialization function. If IDs # are provided, then fault IDs are static. id: type: int diff --git a/gen/schemas/view.yaml b/gen/schemas/view.yaml index dc7e123e..38d28d2b 100644 --- a/gen/schemas/view.yaml +++ b/gen/schemas/view.yaml @@ -57,7 +57,7 @@ mapping: # The type of filter to be applied. # component_name - filter by component names # component_type - filter by component types - # component_execution - filter by component exucution types (active or passive) + # component_execution - filter by component execution types (active or passive) # component_name_context - filter by component name and all it's immediate connections # component_type_context - filter by component type and all it's immediate connections # connector_name - filter by connector_names diff --git a/gen/templates/array/name.ads b/gen/templates/array/name.ads index 0ab519d9..0de1c213 100644 --- a/gen/templates/array/name.ads +++ b/gen/templates/array/name.ads @@ -350,7 +350,7 @@ package {{ name }} is -- Return a field (provided by a field number) as a polymorphic type. -- This is useful for returning any field in a array in a very generic -- way. Fields bigger than the polymorphic type will only have their - -- least signficant bits returned. This function should be used in tandem + -- least significant bits returned. This function should be used in tandem -- with the Validation package to create useful error messages for an invalid -- type: function Get_Field (Src : in T; Field : in Interfaces.Unsigned_32) return Basic_Types.Poly_Type; diff --git a/gen/templates/array/name.m b/gen/templates/array/name.m index 4161bb28..44b0b35f 100644 --- a/gen/templates/array/name.m +++ b/gen/templates/array/name.m @@ -107,7 +107,7 @@ end function pred = is_equal(self, other, num_elements_to_compare) - % Special __eq__ funciton when you only want to compare a certain number of elements in the array + % Special __eq__ function when you only want to compare a certain number of elements in the array % not every element in the array. pred = length(class(self)) == length(class(other)); if pred diff --git a/gen/templates/array/name.py b/gen/templates/array/name.py index f647a945..e4d8e287 100644 --- a/gen/templates/array/name.py +++ b/gen/templates/array/name.py @@ -87,7 +87,7 @@ def __eq__(self, other): def serialized_length(self): # in bytes return self._size_in_bytes - # Special __eq__ funciton when you only want to compare a certain number of elements in the array + # Special __eq__ function when you only want to compare a certain number of elements in the array # not every element in the array. def is_equal(self, other, num_elements_to_compare=None): if num_elements_to_compare is None: diff --git a/gen/templates/assembly/name.ads b/gen/templates/assembly/name.ads index 586f18ca..37bf5ad0 100644 --- a/gen/templates/assembly/name.ads +++ b/gen/templates/assembly/name.ads @@ -92,7 +92,7 @@ package {{ name }} is {{ task.component_name }}_{{ task.name }}_Task_Info : aliased Task_Types.Task_Info := ( Number => {{ task.number }}, Id => Ada.Task_Identification.Null_Task_Id, - -- The following is initialized by the component iself. + -- The following is initialized by the component itself. Priority => 0, Stack_Address => System.Null_Address, Stack_Size => 0, diff --git a/gen/templates/assembly/name.dot b/gen/templates/assembly/name.dot index 9af4d703..7270301a 100644 --- a/gen/templates/assembly/name.dot +++ b/gen/templates/assembly/name.dot @@ -27,7 +27,7 @@ digraph {{ name }} { color=gray {% endif %} - // Coponents in cluster_{{ loop.index }} + // Components in cluster_{{ loop.index }} {% for name, component in group.items() %} {{ component.instance_name }} [ {% if component.instance_execution == "active" and show_switches["show_component_execution"] %} diff --git a/gen/templates/assembly/name_data_dependencies.ads b/gen/templates/assembly/name_data_dependencies.ads index af7f4b42..587cd670 100644 --- a/gen/templates/assembly/name_data_dependencies.ads +++ b/gen/templates/assembly/name_data_dependencies.ads @@ -16,7 +16,7 @@ package {{ name }}_Data_Dependencies is Number_Of_Data_Dependencies : constant Natural := {{ data_dependencies|length }}; Number_Of_Components_With_Data_Dependencies : constant Natural := {{ component_kind_dict['data_dependencies']|length }}; - -- List of data dependency ids. These have been resoved and refer to data product IDs in the system: + -- List of data dependency ids. These have been resolved and refer to data product IDs in the system: {% for id, dd in data_dependencies.items() %} {{ dd.suite.component.instance_name }}_{{ dd.name }} : constant Data_Product_Id := {{ dd.id }}; -- 0x{{ '%04x' % id }} {% endfor %} diff --git a/gen/templates/component/component-name-implementation.ads b/gen/templates/component/component-name-implementation.ads index 4255b0a6..fdeddc9b 100644 --- a/gen/templates/component/component-name-implementation.ads +++ b/gen/templates/component/component-name-implementation.ads @@ -180,7 +180,7 @@ private -- Description: {{ printMultiLine(data_dependencies.description, ' -- ') }} {% endif %} - -- Function which retreives a data dependency. + -- Function which retrieves a data dependency. -- The default implementation is to simply call the Data_Product_Fetch_T_Request connector. Change the implementation if this component -- needs to do something different. overriding function Get_Data_Dependency (Self : in out Instance; Id : in Data_Product_Types.Data_Product_Id) return Data_Product_Return.T is (Self.Data_Product_Fetch_T_Request ((Id => Id))); diff --git a/gen/templates/component/component-name.ads b/gen/templates/component/component-name.ads index 98136583..8359cb95 100644 --- a/gen/templates/component/component-name.ads +++ b/gen/templates/component/component-name.ads @@ -278,7 +278,7 @@ package Component.{{ name }} is -- Description: {{ printMultiLine(data_dependencies.description, ' -- ') }} {% endif %} - -- Function which retreives a data dependency. This should be overridden by the implementation to call the correct connector. + -- Function which retrieves a data dependency. This should be overridden by the implementation to call the correct connector. not overriding function Get_Data_Dependency (Self : in out Base_Instance; Id : in Data_Product_Types.Data_Product_Id) return Data_Product_Return.T is abstract; -- Invalid data dependency handler. This procedure is called when a data dependency's id or length are found to be invalid: @@ -331,7 +331,7 @@ private ); {% if connectors.arrayed_invokee() %} - -- Define connector indentifier record, which also includes + -- Define connector identifier record, which also includes -- room for the index that the connector is being invoked on. type Connector_Identifier_Type is record Id : Connector_Identifier_Enum; @@ -350,7 +350,7 @@ private Index at 0 range 8 .. 23; end record; {% else %} - -- Define packed connector indentifier record. + -- Define packed connector identifier record. type Connector_Identifier_Type is record Id : Connector_Identifier_Enum; end record diff --git a/gen/templates/component/name_init.tex b/gen/templates/component/name_init.tex index a026f9c8..58fdbeba 100644 --- a/gen/templates/component/name_init.tex +++ b/gen/templates/component/name_init.tex @@ -116,7 +116,7 @@ \subsubsection{Component Set ID Bases} \end{spaceditemize} \vspace{5mm} %5mm vertical space %- else -This component contains no commands, events, packets, faults or data products that need base indentifiers. +This component contains no commands, events, packets, faults or data products that need base identifiers. %- endif \subsubsection{Component Map Data Dependencies} diff --git a/gen/templates/record/name-validation.adb b/gen/templates/record/name-validation.adb index 79bd66d6..4009b603 100644 --- a/gen/templates/record/name-validation.adb +++ b/gen/templates/record/name-validation.adb @@ -71,7 +71,7 @@ package body {{ name }}.Validation is {% endfor %} {% endif %} -- - -- Check individial fields: + -- Check individual fields: -- {% for field in fields.values() %} @@ -203,7 +203,7 @@ package body {{ name }}.Validation is {% endfor %} {% endif %} -- - -- Check individial fields: + -- Check individual fields: -- {% for field in fields.values() %} @@ -335,7 +335,7 @@ package body {{ name }}.Validation is {% endfor %} {% endif %} -- - -- Check individial fields: + -- Check individual fields: -- {% for field in fields.values() %} -- Check {{ field.name }}: diff --git a/gen/templates/record/name.ads b/gen/templates/record/name.ads index b01e0c71..71d11f15 100644 --- a/gen/templates/record/name.ads +++ b/gen/templates/record/name.ads @@ -472,7 +472,7 @@ package {{ name }} is -- Return a field (provided by a field number) as a polymorphic type. -- This is useful for returning any field in a record in a very generic -- way. Fields bigger than the polymorphic type will only have their - -- least signficant bits returned. This function should be used in tandem + -- least significant bits returned. This function should be used in tandem -- with the Validation package to create useful error messages for an invalid -- type: function Get_Field (Src : in T; Field : in Interfaces.Unsigned_32) return Basic_Types.Poly_Type; diff --git a/gen/templates/tests/component-name_reciprocal.adb b/gen/templates/tests/component-name_reciprocal.adb index 0eb0bf29..68d481be 100644 --- a/gen/templates/tests/component-name_reciprocal.adb +++ b/gen/templates/tests/component-name_reciprocal.adb @@ -483,7 +483,7 @@ package body Component.{{ name }}_Reciprocal is subtype Sized_Byte_Array is Basic_Types.Byte_Array (Sized_Byte_Array_Index); Overlay : Sized_Byte_Array with Import, Convention => Ada, Address => Item'Address; begin - -- Safely copy the buffer to the overlayed type: + -- Safely copy the buffer to the overlaid type: Safe_Left_Copy (Overlay, P.Buffer (P.Buffer'First .. P.Buffer'First + P.Header.Buffer_Length - 1)); end; end if; diff --git a/gen/templates/tests/component-name_reciprocal.ads b/gen/templates/tests/component-name_reciprocal.ads index 703f4972..bf6bca5a 100644 --- a/gen/templates/tests/component-name_reciprocal.ads +++ b/gen/templates/tests/component-name_reciprocal.ads @@ -146,7 +146,7 @@ package Component.{{ name }}_Reciprocal is -- System time for test: System_Time : Sys_Time.T := (0, 0); {% endif %} - -- Flags for different log outputs that are avaliable for this component. There are switches for each connector and each item of each connector. + -- Flags for different log outputs that are available for this component. There are switches for each connector and each item of each connector. Log_Verbose : Boolean := False; {% if connectors %} {% for connector in connectors %} diff --git a/gen/templates/tests/name.adb b/gen/templates/tests/name.adb index 37fb47c5..0a44354b 100644 --- a/gen/templates/tests/name.adb +++ b/gen/templates/tests/name.adb @@ -25,7 +25,7 @@ package body {{ name }} is Self.Logger.Log (String_Util.Trim_Both (String_To_Log)); end Log; - -- Initalize the logging for the log file ensuring the correct directory is avaliable + -- Initialize the logging for the log file ensuring the correct directory is available procedure Init_Logging (Self : in out Base_Instance; File_Name : in String) is use Ada.Calendar.Formatting; -- The path returned by the Command_Name is the path to the test.elf, so back out to the build directory diff --git a/gen/templates/tests/name.ads b/gen/templates/tests/name.ads index 906416e3..250fbca4 100644 --- a/gen/templates/tests/name.ads +++ b/gen/templates/tests/name.ads @@ -40,7 +40,7 @@ package {{ name }} is procedure Set_Up_Test (Self : in out Base_Instance) is abstract; procedure Tear_Down_Test (Self : in out Base_Instance) is abstract; - -- Number of tests varable + -- Number of tests variable Num_Tests : constant Positive := {{ tests|length }}; -- Test name list type for the names diff --git a/gen/templates/tex/inputs/code_style.tex b/gen/templates/tex/inputs/code_style.tex index 3c3d2379..3e36fbc4 100644 --- a/gen/templates/tex/inputs/code_style.tex +++ b/gen/templates/tex/inputs/code_style.tex @@ -9,7 +9,7 @@ \definecolor{sbase1}{HTML}{93A1A1} \definecolor{sbase2}{HTML}{EEE8D5} %\definecolor{sbase3}{HTML}{FDF6E3} -% changing this a bit for readibility in pdf +% changing this a bit for readability in pdf \definecolor{sbase3}{HTML}{FEF9ED} \definecolor{syellow}{HTML}{B58900} \definecolor{sorange}{HTML}{CB4B16} diff --git a/gen/test/arrays/test_py/test.py b/gen/test/arrays/test_py/test.py index a8254d10..c1d7ccbc 100644 --- a/gen/test/arrays/test_py/test.py +++ b/gen/test/arrays/test_py/test.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # Build our dependencies using the build system. -# This is necessary because some of the depdencies we +# This is necessary because some of the dependencies we # have are autogenerated. from util import pydep diff --git a/gen/test/enums/test_py/test.py b/gen/test/enums/test_py/test.py index b52e3862..f704a087 100644 --- a/gen/test/enums/test_py/test.py +++ b/gen/test/enums/test_py/test.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # Build our dependencies using the build system. -# This is necessary because some of the depdencies we +# This is necessary because some of the dependencies we # have are autogenerated. from util import pydep diff --git a/gen/test/records/test_py/test.py b/gen/test/records/test_py/test.py index 41f30e02..f0ee56fc 100644 --- a/gen/test/records/test_py/test.py +++ b/gen/test/records/test_py/test.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # Build our dependencies using the build system. -# This is necessary because some of the depdencies we +# This is necessary because some of the dependencies we # have are autogenerated. from util import pydep diff --git a/gen/test/request_service/request_service.component.yaml b/gen/test/request_service/request_service.component.yaml index 208dd501..45ed45d8 100644 --- a/gen/test/request_service/request_service.component.yaml +++ b/gen/test/request_service/request_service.component.yaml @@ -2,7 +2,7 @@ description: This is a simple test component which has a request-service connector. execution: passive connectors: - - description: The requestor connector + - description: The requester connector kind: request type: Aa.T return_type: Aa.T diff --git a/gnd/bin/decode_event_log.py b/gnd/bin/decode_event_log.py index 5fd9ccbe..2d967ebd 100644 --- a/gnd/bin/decode_event_log.py +++ b/gnd/bin/decode_event_log.py @@ -5,7 +5,7 @@ from util import redo from util import crc_16 -# We have a few autocoded depdendencies we need to import. So do that: +# We have a few autocoded dependencies we need to import. So do that: pydep.build_py_deps() from ccsds_space_packet import Ccsds_Space_Packet from event import Event diff --git a/gnd/bin/decode_event_packets.py b/gnd/bin/decode_event_packets.py index e1c442fd..e232a97a 100644 --- a/gnd/bin/decode_event_packets.py +++ b/gnd/bin/decode_event_packets.py @@ -5,7 +5,7 @@ from util import redo from util import crc_16 -# We have a few autocoded depdendencies we need to import. So do that: +# We have a few autocoded dependencies we need to import. So do that: pydep.build_py_deps() from ccsds_space_packet import Ccsds_Space_Packet from event import Event diff --git a/gnd/bin/socket_event_decoder.py b/gnd/bin/socket_event_decoder.py index 1127e633..e7c5d497 100755 --- a/gnd/bin/socket_event_decoder.py +++ b/gnd/bin/socket_event_decoder.py @@ -61,7 +61,7 @@ ) args = parser.parse_args() - # We have a few autocoded depdendencies we need to import. So do that: + # We have a few autocoded dependencies we need to import. So do that: if not args.P: from util import pydep @@ -142,7 +142,7 @@ def timestamp_str(): try: event_data, server = client_socket.recvfrom(packet_len) # print_log("got data: " + str(len(event_data))) - # If data is large enough to be a valid packet, the try to pase it. + # If data is large enough to be a valid packet, then try to pass it. if event_data and len(event_data) >= min_packet_len: # The binary data should be a set of CCSDS packets, so extract those: packet = Ccsds_Space_Packet.create_from_byte_array(event_data) @@ -200,7 +200,7 @@ def timestamp_str(): except socket.error: client_socket.close() print_log( - "Socket error occured: {} | Exiting".format(socket.error) + "Socket error occurred: {} | Exiting".format(socket.error) + " at " + timestamp_str() ) @@ -210,4 +210,4 @@ def timestamp_str(): print_log("Socket Closed | Exiting at " + timestamp_str()) sys.exit(0) except BaseException as e: - print_log("Unexpected error occured:\n" + str(e)) + print_log("Unexpected error occurred:\n" + str(e)) diff --git a/gnd/hydra/README.md b/gnd/hydra/README.md index c9b16c1f..7511954b 100644 --- a/gnd/hydra/README.md +++ b/gnd/hydra/README.md @@ -1,3 +1,3 @@ # Hydra -This includes common configuration files for using Adamant with Hydra. Note that Hydra is not yet publically available, but will be made so in the future. +This includes common configuration files for using Adamant with Hydra. Note that Hydra is not yet publicly available, but will be made so in the future. diff --git a/gnd/util/event_class_generator.py b/gnd/util/event_class_generator.py index b569fcdf..8f3dc28b 100644 --- a/gnd/util/event_class_generator.py +++ b/gnd/util/event_class_generator.py @@ -75,7 +75,7 @@ def pretty_print_string(self): # Testing code: if __name__ == "__main__": # Build our dependencies using the build system. - # This is necessary because some of the depdencies we + # This is necessary because some of the dependencies we # have are autogenerated. from util import pydep diff --git a/redo/base_classes/build_target_base.py b/redo/base_classes/build_target_base.py index 79343628..bd1ceef0 100644 --- a/redo/base_classes/build_target_base.py +++ b/redo/base_classes/build_target_base.py @@ -19,7 +19,7 @@ def gnat_stack_limit(self): return 10250 # The default implementation of this is for native, so the string is blank. For - # arm this might be overridden to "arm-eabi-" or something similiar. This is preprended + # arm this might be overridden to "arm-eabi-" or something similar. This is prepended # to ada_compiler, c_compiler etc below: def compiler_prefix(self): return "" @@ -71,7 +71,7 @@ def ada_compiler_flags(self): # Optional: Return a list of extra include flags # for the compiler. All includes will be prepended - # by "-I" and seperated by a space when put in the + # by "-I" and separated by a space when put in the # compilation command. # Note: All source included in the build_path # is already automatically included in the compile @@ -97,7 +97,7 @@ def ada_binder_flags(self): # Optional: Return a string of extra include flags # for the binder. All includes must be prepended - # by "-I" and seperated by a space. + # by "-I" and separated by a space. # Note: All source included in the build_path # is already automatically included in the bind # command and does not need to be returned here. @@ -145,7 +145,7 @@ def c_compiler_flags(self): # Optional: Return a list of extra include flags # for the compiler. All includes will be prepended - # by "-I" and seperated by a space when put in the + # by "-I" and separated by a space when put in the # compilation command. # Note: All source included in the build_path # is already automatically included in the compile @@ -170,7 +170,7 @@ def cpp_compiler_flags(self): # Optional: Return a list of extra include flags # for the compiler. All includes will be prepended - # by "-I" and seperated by a space when put in the + # by "-I" and separated by a space when put in the # compilation command. # Note: All source included in the build_path # is already automatically included in the compile diff --git a/redo/base_classes/generator_base.py b/redo/base_classes/generator_base.py index a4147cca..2f63087a 100644 --- a/redo/base_classes/generator_base.py +++ b/redo/base_classes/generator_base.py @@ -41,7 +41,7 @@ def output_filename(self, input_filename): # build rule so that the hand written "overriding" file is # used instead. # - # Note: this function can be overriden by the inheriting class + # Note: this function can be overridden by the inheriting class # if this default behavior is not desired. def output_filename_(self, input_filename): # Call the enherited class output_filename method: diff --git a/redo/base_classes/gprbuild_target_base.py b/redo/base_classes/gprbuild_target_base.py index d2505052..fa20f064 100644 --- a/redo/base_classes/gprbuild_target_base.py +++ b/redo/base_classes/gprbuild_target_base.py @@ -63,8 +63,8 @@ def _get_gnat_install_dir(self): # So gnatmetric does not work well with project files, at least in the # unique way that Adamant uses .gpr files. The build system instead calls - # gnatmetric without any reference to project files. This is unforunate - # because we are requiring the user to redifine some of the information + # gnatmetric without any reference to project files. This is unfortunate + # because we are requiring the user to redefine some of the information # flags/etc here in order to get gnatmetric to work. This is a hack, # but is a solution that works for now. Building metrics is not # used as commonly or is as essential as compilation, so a bit of oddness diff --git a/redo/codespell/ignore_list.txt b/redo/codespell/ignore_list.txt new file mode 100644 index 00000000..a03a0e3b --- /dev/null +++ b/redo/codespell/ignore_list.txt @@ -0,0 +1,2 @@ +invokee +crate \ No newline at end of file diff --git a/redo/database/_setup.py b/redo/database/_setup.py index 3bc36170..97b46cb0 100644 --- a/redo/database/_setup.py +++ b/redo/database/_setup.py @@ -14,7 +14,7 @@ # This module is private in that it exposes no public # function that are meant to be called externally. The # exception is database/setup.py, which calls the _setup() -# funtion in this module. The purpose of splitting the two +# function in this module. The purpose of splitting the two # modules up is to improve performance. Most of the time # the setup module is used, it does not need to import all the # many modules that these function require. By splitting the @@ -28,7 +28,7 @@ # The dictionary is ordered, since order matters for things like # c compilation. We want to include project specific paths last # so that they can overwrite things in the database last, taking -# precidence over same-named things in the core framework. +# precedence over same-named things in the core framework. # ie. src/core/stuff.h in a project specific directory will be # built/used instead of a src/core/stuff.h in a framework dir class _build_path(OrderedDict): @@ -178,7 +178,7 @@ def _get_build_roots(cwd): return list(set([adamant_root, current_root])) -# Santize a list of directories, removing empty +# Sanitize a list of directories, removing empty # strings and removing duplicates. def _sanitize_path(path): path = list(filter(bool, path)) @@ -243,13 +243,13 @@ def _setup(redo_1, redo_2, redo_3, sandbox=False): # Create temporary directory to store source code links. This optimization # speeds up object compilation times. source_link_dir = linkdir + os.sep + "src" - # Set environment variable so that object compilation can retreive this location: + # Set environment variable so that object compilation can retrieve this location: os.environ["SOURCE_LINK_DIR"] = source_link_dir filesystem.safe_makedir(source_link_dir) # For any top level target that is running this setup we create a .running # file in the session temporary directory. This indicates that this rule # (or its dependencies) are currently building. This file will be removed - # when the building of this target is finished. Ths purpose of this file is + # when the building of this target is finished. The purpose of this file is # to help indicate to the build system when the temporary directory is no # longer begin used, and thus can be removed, freeing up RAM space on the # build machine. @@ -257,14 +257,14 @@ def _setup(redo_1, redo_2, redo_3, sandbox=False): # Create temporary directory to store object links. This optimization # speeds up binding times. object_link_dir = linkdir + os.sep + "obj" - # Set environment variable so that object compilation can retreive this location: + # Set environment variable so that object compilation can retrieve this location: os.environ["OBJECT_LINK_DIR"] = object_link_dir filesystem.safe_makedir(object_link_dir) # Create temporary directory to store pre-built object files. This optimization # speeds up compilation times by allowing multiple objects to be built at the # same time using GPRBuild. object_pre_build_dir = linkdir + os.sep + "obj_pre" - # Set environment variable so that object compilation can retreive this location: + # Set environment variable so that object compilation can retrieve this location: os.environ["OBJECT_PRE_BUILD_DIR"] = object_pre_build_dir filesystem.safe_makedir(object_pre_build_dir) db_dir = linkdir + os.sep + "db" diff --git a/redo/database/c_source_database.py b/redo/database/c_source_database.py index 46d55459..d5019919 100644 --- a/redo/database/c_source_database.py +++ b/redo/database/c_source_database.py @@ -20,7 +20,7 @@ # This database is useful for figuring out where c source is located # in the system given just a base name (which may be all that is included # in the "#include" dependencies of a C source file). Note that all -# entries in this database must be uniqe, meaning that C files in the +# entries in this database must be unique, meaning that C files in the # build path of the same name, but in different directories are not # allowed in Adamant, because of the interface with Ada, even though # this pattern is allowed by the C language specification. diff --git a/redo/database/create.py b/redo/database/create.py index 0e23ab7d..bff66263 100644 --- a/redo/database/create.py +++ b/redo/database/create.py @@ -91,7 +91,7 @@ def _add_to_regex_dict_of_sets(dic, regex, object_instance): dic[regex] = (cregex, {object_instance}) -# Similiar to above but add a regex + ".do" +# Similar to above but add a regex + ".do" def _add_to_regex_dict_of_sets_w_do(dic, regex, object_instance): if regex in dic: cregex, do_cregex, oi_set = dic[regex] @@ -281,7 +281,7 @@ def _add_to_dict_of_sets(dic, key, value): # Create new build system databases that do not depend on -# the buid path. We split this up because this operation can +# the build path. We split this up because this operation can # be run even before the build path is calculated, which is # necessary for some operations. def create_pre_build_path(): @@ -465,7 +465,7 @@ def _compute_generated_files(input_files): # Add the do target to the redo_targets: redo_target_dict.add_target(directory, do_target) # If this do file builds an source file add it to the - # source database if it is not already in the source databse + # source database if it is not already in the source database if _is_ada_source_file( do_target ) and do_target not in source_db.try_get_source( diff --git a/redo/database/database.py b/redo/database/database.py index f550bf93..23658e3f 100644 --- a/redo/database/database.py +++ b/redo/database/database.py @@ -19,7 +19,7 @@ # data type can be stored within the underlying unqlite # database. -# UNQLITE Constant Definitons. For some reason +# UNQLITE Constant Definitions. For some reason # I cannot find this in the unqlite module, so I # have just redefined them here. _UNQLITE_OPEN_READONLY = 0x00000001 diff --git a/redo/database/model_database.py b/redo/database/model_database.py index bcd74d0e..f532ce7f 100644 --- a/redo/database/model_database.py +++ b/redo/database/model_database.py @@ -8,7 +8,7 @@ # Split a model filename into its components and # check to make sure that is complies with the adamant -# model file nameing convention. +# model file naming convention. def split_model_file_name(model_filename): def err(string): error.error_abort( diff --git a/redo/database/setup.py b/redo/database/setup.py index 3eb3aeab..2af73926 100644 --- a/redo/database/setup.py +++ b/redo/database/setup.py @@ -61,7 +61,7 @@ def reset(): # This function does any necessary build system cleanup. # It will only do the cleanup if this is the top level -# instatiation of redo. +# instantiation of redo. def cleanup(redo_1, redo_2, redo_3): if "TOP_LEVEL_TARGET" in os.environ and os.environ["TOP_LEVEL_TARGET"] == redo_1: from database import _setup diff --git a/redo/rules/build_executable.py b/redo/rules/build_executable.py index 509c6744..b1059f7b 100644 --- a/redo/rules/build_executable.py +++ b/redo/rules/build_executable.py @@ -289,7 +289,7 @@ def _build(self, redo_1, redo_2, redo_3): if "DEBUG" in os.environ and os.environ["DEBUG"]: do_debug = True - # Run the linke and bind commands in .gpr directory: + # Run the link and bind commands in .gpr directory: cwd = os.getcwd() os.chdir(gpr_project_file_dir) shell.run_command(bind_command, debug=do_debug) diff --git a/redo/rules/build_object.py b/redo/rules/build_object.py index 89b5de76..5fc01934 100644 --- a/redo/rules/build_object.py +++ b/redo/rules/build_object.py @@ -101,7 +101,7 @@ def _get_all_dependencies(source_files): ] # Special handling to make sure we build C-objects for which we have - # Ada bindings: In most cases if Ada calls into C/C++ or vise versa + # Ada bindings: In most cases if Ada calls into C/C++ or vice versa # there is no way of "discovering" that that dependency exists. However, # in this special case we can follow a convention to cover the common case # where a user has generated Ada bindings for .h or .hpp file. These generated @@ -453,7 +453,7 @@ def _precompile_objects(object_files): # the final location and dependency tracking has been handled. def _handle_prebuilt_object(redo_1, redo_2, redo_3): # First see if the object has already been compiled and is in the object temp dir. This - # is a speed optimization that may have already occured. + # is a speed optimization that may have already occurred. temp_object_dir = os.environ["OBJECT_PRE_BUILD_DIR"] temp_object_file = os.path.join(temp_object_dir, os.path.basename(redo_1)) if os.path.isfile(temp_object_file): diff --git a/redo/rules/build_publish.py b/redo/rules/build_publish.py index 1317c33e..d09ed7b7 100644 --- a/redo/rules/build_publish.py +++ b/redo/rules/build_publish.py @@ -12,7 +12,7 @@ # are built using the build_pdf rule, the are constructed in # a build/pdf directory. Since these directories are removed # upon cleaning, they are not permanently saved in the repository. -# In order to permanantly save PDF documentation, so that we +# In order to permanently save PDF documentation, so that we # don't always have to recompile them to use them, this "publish" # rule was created. # diff --git a/redo/rules/build_style.py b/redo/rules/build_style.py index 11aa020a..a8fed45a 100644 --- a/redo/rules/build_style.py +++ b/redo/rules/build_style.py @@ -10,7 +10,7 @@ import glob -# This command is the equivelant of turning on style checking +# This command is the equivalent of turning on style checking # and recompiling all objects within the current directory. ie. # # $ export CHECK_STYLE=True @@ -48,7 +48,7 @@ def _build(self, redo_1, redo_2, redo_3): # Turn on the style checking: os.environ["CHECK_STYLE"] = "True" - # Simply force recompile all the objects in this directory whith style checking enabled + # Simply force recompile all the objects in this directory with style checking enabled # and we will get nice style check messages. filesystem.safe_makedir(style_directory) style_log_file = style_directory + os.sep + "style.log" @@ -85,6 +85,20 @@ def _build(self, redo_1, redo_2, redo_3): shell.run_command(flake_cmd) os.chdir(cwd) + # Run codespell check: + codespell_cwd = directory + os.sep + "*.*" + codespell_ignore = os.environ["ADAMANT_DIR"] + os.sep + "redo" + os.sep + "codespell" + os.sep + "ignore_list.txt" + codespell_output = "\" 2>&1 | tee -a " + style_log_file + " 1>&2" + codespell_build_dir = "*" + os.sep + "build" + os.sep + "obj,*" + os.sep + "build" + os.sep + "bin" + codespell_skip = " --skip=\"*" + os.sep + "alire," + codespell_build_dir + ",*.pdf,*.eps,*.svg," + style_directory + codespell_suffix = " -I " + codespell_ignore + codespell_skip + codespell_output + shell.run_command("codespell " + + codespell_cwd + + codespell_suffix) + shell.run_command("codespell " + + build_directory + + codespell_suffix) + # Finally lint any YAML files: def _yaml_lint(filenames=[]): cmd = ( diff --git a/redo/rules/build_test.py b/redo/rules/build_test.py index 52ce5a36..1deb5f4c 100644 --- a/redo/rules/build_test.py +++ b/redo/rules/build_test.py @@ -68,7 +68,7 @@ def _build(self, redo_1, redo_2, redo_3): error.abort() # For some reason AUnit does not produce an errored return status if - # no assertions failed but an unexpected error occured. Fix this: + # no assertions failed but an unexpected error occurred. Fix this: if bool(re.search(r"Unexpected\s+Errors:\s+[1-9][0-9]*", stdout)) or bool( re.search(r"Unexpected\s+Errors:\s+[1-9][0-9]*", stderr) ): diff --git a/redo/rules/build_via_generator.py b/redo/rules/build_via_generator.py index b8a33415..3215b242 100644 --- a/redo/rules/build_via_generator.py +++ b/redo/rules/build_via_generator.py @@ -12,7 +12,7 @@ # This private function runs a generator. It first inspects # the output filename and makes sure that it is a registered -# product in the generator database. If it is, it retreives the +# product in the generator database. If it is, it retrieves the # appropriate generator, and runs it on the input file to # generate the output file. def _generate(output_filename): diff --git a/redo/targets/codepeer/AdamantMessagePatterns.xml b/redo/targets/codepeer/AdamantMessagePatterns.xml index 693fcc0f..203b5407 100644 --- a/redo/targets/codepeer/AdamantMessagePatterns.xml +++ b/redo/targets/codepeer/AdamantMessagePatterns.xml @@ -32,7 +32,7 @@ - + + (instead of low), unless overridden by another rule. --> Argument_Data_Length, Length_Bound => The_Command.Arg_Buffer'Length))); else -- We don't need anything else out of the secondary header, unless an error - -- occures, so just skip right over it. + -- occurs, so just skip right over it. Next_Index := Next_Index + Ccsds_Command_Secondary_Header_Length; -- Set the command header arg buffer length: diff --git a/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer.tests.yaml b/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer.tests.yaml index 2df6d14c..3017996e 100644 --- a/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer.tests.yaml +++ b/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer.tests.yaml @@ -2,9 +2,9 @@ description: This is a unit test suite for the CCSDS Command Depacketizer component tests: - name: Test_Nominal_Depacketization - description: This unit test excersizes the nominal behavior of the ccsds command depacketizer. + description: This unit test exercises the nominal behavior of the ccsds command depacketizer. - name: Test_Invalid_Packet_Checksum - description: This unit test makes sure that packets with invalid checsums are reported and dropped. + description: This unit test makes sure that packets with invalid checksums are reported and dropped. - name: Test_Invalid_Packet_Type description: This unit test makes sure that packets with invalid packet types are reported and dropped. - name: Test_Packet_Too_Small diff --git a/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer_tests-implementation.ads b/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer_tests-implementation.ads index ab9b5fda..57ddb109 100644 --- a/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer_tests-implementation.ads +++ b/src/components/ccsds_command_depacketizer/test/ccsds_command_depacketizer_tests-implementation.ads @@ -12,9 +12,9 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the nominal behavior of the ccsds command depacketizer. + -- This unit test exercises the nominal behavior of the ccsds command depacketizer. overriding procedure Test_Nominal_Depacketization (Self : in out Instance); - -- This unit test makes sure that packets with invalid checsums are reported and dropped. + -- This unit test makes sure that packets with invalid checksums are reported and dropped. overriding procedure Test_Invalid_Packet_Checksum (Self : in out Instance); -- This unit test makes sure that packets with invalid packet types are reported and dropped. overriding procedure Test_Invalid_Packet_Type (Self : in out Instance); diff --git a/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.adb b/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.adb index 13249735..33a7310b 100644 --- a/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.adb +++ b/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.adb @@ -143,14 +143,14 @@ package body Component.Ccsds_Command_Depacketizer.Implementation.Tester is Self.Invalid_Packet_Type_History.Push (Arg); end Invalid_Packet_Type; - -- The packet recieved was too small to contain necessary command information. + -- The packet received was too small to contain necessary command information. overriding procedure Packet_Too_Small (Self : in out Instance; Arg : in Invalid_Packet_Length.T) is begin -- Push the argument onto the test history for looking at later: Self.Packet_Too_Small_History.Push (Arg); end Packet_Too_Small; - -- The packet recieved was too large and is bigger than the size of a command. + -- The packet received was too large and is bigger than the size of a command. overriding procedure Packet_Too_Large (Self : in out Instance; Arg : in Invalid_Packet_Length.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.ads b/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.ads index 062ead58..4153aaad 100644 --- a/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.ads +++ b/src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.ads @@ -110,9 +110,9 @@ package Component.Ccsds_Command_Depacketizer.Implementation.Tester is overriding procedure Invalid_Packet_Checksum (Self : in out Instance; Arg : in Invalid_Packet_Xor8_Info.T); -- A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemtry packet was received. overriding procedure Invalid_Packet_Type (Self : in out Instance; Arg : in Ccsds_Primary_Header.T); - -- The packet recieved was too small to contain necessary command information. + -- The packet received was too small to contain necessary command information. overriding procedure Packet_Too_Small (Self : in out Instance; Arg : in Invalid_Packet_Length.T); - -- The packet recieved was too large and is bigger than the size of a command. + -- The packet received was too large and is bigger than the size of a command. overriding procedure Packet_Too_Large (Self : in out Instance; Arg : in Invalid_Packet_Length.T); -- A packet was received without a secondary header, but the secondary header is required. overriding procedure No_Secondary_Header (Self : in out Instance; Arg : in Ccsds_Primary_Header.T); diff --git a/src/components/ccsds_downsampler/apid_tree/apid_tree.adb b/src/components/ccsds_downsampler/apid_tree/apid_tree.adb index 663de6cd..684fea13 100644 --- a/src/components/ccsds_downsampler/apid_tree/apid_tree.adb +++ b/src/components/ccsds_downsampler/apid_tree/apid_tree.adb @@ -40,7 +40,7 @@ package body Apid_Tree is Search_Status : constant Boolean := Self.Downsample_Entry.Search (((Apid => Apid, Filter_Factor => 1, Filter_Count => 0)), Fetched_Entry, Tree_Index); begin case Search_Status is - -- If we couldnt find the packet, then increment the pass count and move on + -- If we couldn't find the packet, then increment the pass count and move on when False => -- Update the counter and return the status Self.Num_Passed_Packets := Self.Num_Passed_Packets + 1; @@ -81,7 +81,7 @@ package body Apid_Tree is Index : Positive; Search_Status : constant Boolean := Self.Downsample_Entry.Search ((Apid => Apid, Filter_Factor => 1, Filter_Count => 0), Fetched_Entry, Index); begin - -- set the index output variable just incase we dont find the entry + -- set the index output variable just in case we dont find the entry Tree_Index := Positive'First; case Search_Status is when True => diff --git a/src/components/ccsds_downsampler/apid_tree/test/apid_tree.tests.yaml b/src/components/ccsds_downsampler/apid_tree/test/apid_tree.tests.yaml index 446e027b..459e2da4 100644 --- a/src/components/ccsds_downsampler/apid_tree/test/apid_tree.tests.yaml +++ b/src/components/ccsds_downsampler/apid_tree/test/apid_tree.tests.yaml @@ -2,7 +2,7 @@ description: This is a unit test suite for the apid_ tree object for help with the ccsds_downsampler tests: - name: Test_Init_List - description: This test is inteded to test the different permutations of the init of the apid and filter factor type array. + description: This test is intended to test the different permutations of the init of the apid and filter factor type array. - name: Test_Set_Filter_Factor description: This unit test tests changing the value of the filter factor for a given apid. - name: Test_Get_Counters diff --git a/src/components/ccsds_downsampler/apid_tree/test/apid_tree_tests-implementation.ads b/src/components/ccsds_downsampler/apid_tree/test/apid_tree_tests-implementation.ads index 949bc3e0..99565890 100644 --- a/src/components/ccsds_downsampler/apid_tree/test/apid_tree_tests-implementation.ads +++ b/src/components/ccsds_downsampler/apid_tree/test/apid_tree_tests-implementation.ads @@ -12,7 +12,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This test is inteded to test the different permutations of the init of the apid and filter factor type array. + -- This test is intended to test the different permutations of the init of the apid and filter factor type array. overriding procedure Test_Init_List (Self : in out Instance); -- This unit test tests changing the value of the filter factor for a given apid. overriding procedure Test_Set_Filter_Factor (Self : in out Instance); diff --git a/src/components/ccsds_downsampler/ccsds_downsampler.commands.yaml b/src/components/ccsds_downsampler/ccsds_downsampler.commands.yaml index 4a53c4f1..4189699e 100644 --- a/src/components/ccsds_downsampler/ccsds_downsampler.commands.yaml +++ b/src/components/ccsds_downsampler/ccsds_downsampler.commands.yaml @@ -2,5 +2,5 @@ description: These are the commands for the ccsds downsampler component. commands: - name: Modify_Filter_Factor - description: Modifiy the filter factor of a specified APID. A value of 0 will filter all packets of that ID. + description: Modify the filter factor of a specified APID. A value of 0 will filter all packets of that ID. arg_type: Filter_Factor_Cmd_Type.T diff --git a/src/components/ccsds_downsampler/ccsds_downsampler.component.yaml b/src/components/ccsds_downsampler/ccsds_downsampler.component.yaml index b8abf55b..87328f83 100644 --- a/src/components/ccsds_downsampler/ccsds_downsampler.component.yaml +++ b/src/components/ccsds_downsampler/ccsds_downsampler.component.yaml @@ -27,7 +27,7 @@ connectors: - description: The connector for data products type: Data_Product.T kind: send - - description: The Event connector to send the events specifc to the component. + - description: The Event connector to send the events specific to the component. type: Event.T kind: send - description: The system time is retrieved via this connector. diff --git a/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.adb b/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.adb index fe07f420..e8eb0639 100644 --- a/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.adb +++ b/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.adb @@ -132,7 +132,7 @@ package body Component.Ccsds_Downsampler.Implementation is ----------------------------------------------- -- Description: -- These are the commands for the ccsds downsampler component. - -- Modifiy the filter factor of a specified APID. A value of 0 will filter all packets of that ID. + -- Modify the filter factor of a specified APID. A value of 0 will filter all packets of that ID. overriding function Modify_Filter_Factor (Self : in out Instance; Arg : in Filter_Factor_Cmd_Type.T) return Command_Execution_Status.E is use Command_Execution_Status; use Apid_Tree; @@ -145,7 +145,7 @@ package body Component.Ccsds_Downsampler.Implementation is case Status is when Success => Self.Event_T_Send_If_Connected (Self.Events.Modified_Factor_Filter (Self.Sys_Time_T_Get, Arg)); - -- If successfull, then get the entry back and send the data product to also verify + -- If successful, then get the entry back and send the data product to also verify Self.Send_Filter_Data_Product (Self.Apid_Entries.Get_Tree_Entry (Index), Index); return Success; when Invalid_Id => diff --git a/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.ads b/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.ads index 31c69314..baa70332 100644 --- a/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.ads +++ b/src/components/ccsds_downsampler/component-ccsds_downsampler-implementation.ads @@ -90,7 +90,7 @@ private ----------------------------------------------- -- Description: -- These are the commands for the ccsds downsampler component. - -- Modifiy the filter factor of a specified APID. A value of 0 will filter all packets of that ID. + -- Modify the filter factor of a specified APID. A value of 0 will filter all packets of that ID. overriding function Modify_Filter_Factor (Self : in out Instance; Arg : in Filter_Factor_Cmd_Type.T) return Command_Execution_Status.E; -- Invalid command handler. This procedure is called when a command's arguments are found to be invalid: diff --git a/src/components/ccsds_downsampler/test/ccsds_downsampler_tests-implementation.adb b/src/components/ccsds_downsampler/test/ccsds_downsampler_tests-implementation.adb index 3fc5e563..2b765bc1 100644 --- a/src/components/ccsds_downsampler/test/ccsds_downsampler_tests-implementation.adb +++ b/src/components/ccsds_downsampler/test/ccsds_downsampler_tests-implementation.adb @@ -311,7 +311,7 @@ package body Ccsds_Downsampler_Tests.Implementation is Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 28); Data_Product_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get (28), Test_Dp_Recieved (2, 0)); - -- Check that it was successfull + -- Check that it was successful T.Ccsds_Space_Packet_T_Send (Incoming_Packet); Natural_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get_Count, 7); Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 29); diff --git a/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.adb b/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.adb index 5352db4c..c1bed271 100644 --- a/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.adb +++ b/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.adb @@ -83,7 +83,7 @@ package body Component.Ccsds_Downsampler.Implementation.Tester is Self.Dispatch_Data_Product (Arg); end Data_Product_T_Recv_Sync; - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.ads b/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.ads index dcd49f85..d82977f9 100644 --- a/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.ads +++ b/src/components/ccsds_downsampler/test/component-ccsds_downsampler-implementation-tester.ads @@ -77,7 +77,7 @@ package Component.Ccsds_Downsampler.Implementation.Tester is overriding procedure Command_Response_T_Recv_Sync (Self : in out Instance; Arg : in Command_Response.T); -- The connector for data products overriding procedure Data_Product_T_Recv_Sync (Self : in out Instance; Arg : in Data_Product.T); - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); -- The system time is retrieved via this connector. overriding function Sys_Time_T_Return (Self : in out Instance) return Sys_Time.T; diff --git a/src/components/ccsds_packetizer/test/ccsds_packetizer.tests.yaml b/src/components/ccsds_packetizer/test/ccsds_packetizer.tests.yaml index faf811ab..4aef11d9 100644 --- a/src/components/ccsds_packetizer/test/ccsds_packetizer.tests.yaml +++ b/src/components/ccsds_packetizer/test/ccsds_packetizer.tests.yaml @@ -2,8 +2,8 @@ description: This is a unit test suite for the CCSDS Packetizer component tests: - name: Test_Nominal_Packetization - description: This unit test excersizes the nominal behavior of the CCSDS Packetizer, checking all emitted CCSDS packets for correctness. + description: This unit test exercises the nominal behavior of the CCSDS Packetizer, checking all emitted CCSDS packets for correctness. - name: Test_Max_Size_Packetization - description: This unit test excersizes the packetization of a maximum sized Adamant packet into a CCSDS packet, which should succeed without issue. + description: This unit test exercises the packetization of a maximum sized Adamant packet into a CCSDS packet, which should succeed without issue. - name: Test_Min_Size_Packetization - description: This unit test excersizes the packetization of a minimum sized Adamant packet into a CCSDS packet, which should succeed without issue. + description: This unit test exercises the packetization of a minimum sized Adamant packet into a CCSDS packet, which should succeed without issue. diff --git a/src/components/ccsds_packetizer/test/ccsds_packetizer_tests-implementation.ads b/src/components/ccsds_packetizer/test/ccsds_packetizer_tests-implementation.ads index 92b8b5cb..056645b6 100644 --- a/src/components/ccsds_packetizer/test/ccsds_packetizer_tests-implementation.ads +++ b/src/components/ccsds_packetizer/test/ccsds_packetizer_tests-implementation.ads @@ -11,11 +11,11 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the nominal behavior of the ccsds packetizer. + -- This unit test exercises the nominal behavior of the ccsds packetizer. overriding procedure Test_Nominal_Packetization (Self : in out Instance); - -- This unit test excersizes the packetization of a maximum sized adamant packet into a ccsds packet. + -- This unit test exercises the packetization of a maximum sized adamant packet into a ccsds packet. overriding procedure Test_Max_Size_Packetization (Self : in out Instance); - -- This unit test excersizes the packetization of a minimum sized Adamant packet into a CCSDS packet, which should succeed without issue. + -- This unit test exercises the packetization of a minimum sized Adamant packet into a CCSDS packet, which should succeed without issue. overriding procedure Test_Min_Size_Packetization (Self : in out Instance); -- Test data and state: diff --git a/src/components/ccsds_product_extractor/ccsds_product_extractor.product_extractor_data_products.yaml b/src/components/ccsds_product_extractor/ccsds_product_extractor.product_extractor_data_products.yaml index 87d2c711..c7da749f 100644 --- a/src/components/ccsds_product_extractor/ccsds_product_extractor.product_extractor_data_products.yaml +++ b/src/components/ccsds_product_extractor/ccsds_product_extractor.product_extractor_data_products.yaml @@ -2,5 +2,5 @@ description: Data products for the Ccsds Product Extractor component. data_products: - name: Dummy - description: A dummy data product since this component doesnt have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. + description: A dummy data product since this component doesn't have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. type: Packed_Byte.T diff --git a/src/components/ccsds_product_extractor/ccsds_product_extractor.requirements.yaml b/src/components/ccsds_product_extractor/ccsds_product_extractor.requirements.yaml index c434460b..679f662c 100644 --- a/src/components/ccsds_product_extractor/ccsds_product_extractor.requirements.yaml +++ b/src/components/ccsds_product_extractor/ccsds_product_extractor.requirements.yaml @@ -1,7 +1,7 @@ --- description: The requirements for the CCSDS downsampler component are specified below. requirements: - - text: The component shall take receive ccsds packets and extract a data type if it is part of the inital list of products. + - text: The component shall take receive ccsds packets and extract a data type if it is part of the initial list of products. - text: The component shall check the type of the extracted product and verify that it is valid. - text: The component shall forward data products when extracted and verifyed. - text: The component shall send errors when the extraction is invalid or out of the range of the packet. diff --git a/src/components/ccsds_product_extractor/gen/templates/extracted_products/name.adb b/src/components/ccsds_product_extractor/gen/templates/extracted_products/name.adb index 975a7e04..3633a9ff 100644 --- a/src/components/ccsds_product_extractor/gen/templates/extracted_products/name.adb +++ b/src/components/ccsds_product_extractor/gen/templates/extracted_products/name.adb @@ -38,7 +38,7 @@ package body {{ name }} is Extraction_Status := Extract_Data_Product.Extract_Data_Product (Pkt => Pkt, Offset => {{data_product.offset}}, Length => {{ data_product.product_type }}.Size_In_Bytes, Id => Id, Timestamp => Timestamp, Dp => Dp); {% endif %} - -- Make sure the extraction was successfull, at this point the only failure should be the length + -- Make sure the extraction was successful, at this point the only failure should be the length case Extraction_Status is when Length_Overflow => return Length_Error; when Success => null; @@ -60,7 +60,7 @@ package body {{ name }} is when True => return Success; when False => - -- When there is a validation error, fill in a data structure with the relevent information for the component to use to send an event. + -- When there is a validation error, fill in a data structure with the relevant information for the component to use to send an event. declare P_Type : Basic_Types.Poly_Type := (others => 0); begin diff --git a/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.adb b/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.adb index 1842da37..ce8ad97c 100644 --- a/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.adb +++ b/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.adb @@ -99,7 +99,7 @@ package body Component.Ccsds_Product_Extractor.Implementation.Tester is ----------------------------------------------- -- Description: -- Data products for the Ccsds Product Extractor component. - -- A dummy data product since this component doesnt have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. + -- A dummy data product since this component doesn't have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. overriding procedure Dummy (Self : in out Instance; Arg : in Packed_Byte.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.ads b/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.ads index 245e179f..22ea8142 100644 --- a/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.ads +++ b/src/components/ccsds_product_extractor/test/component-ccsds_product_extractor-implementation-tester.ads @@ -81,7 +81,7 @@ package Component.Ccsds_Product_Extractor.Implementation.Tester is ----------------------------------------------- -- Description: -- Data products for the Ccsds Product Extractor component. - -- A dummy data product since this component doesnt have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. + -- A dummy data product since this component doesn't have its own data products, this provides a base to start from. This will be removed and replaced with the extracted products that the user defines in the extracted_products YAML file. overriding procedure Dummy (Self : in out Instance; Arg : in Packed_Byte.T); ----------------------------------------------- diff --git a/src/components/ccsds_product_extractor/types/invalid_product_length.record.yaml b/src/components/ccsds_product_extractor/types/invalid_product_length.record.yaml index d53c5d96..7395c352 100644 --- a/src/components/ccsds_product_extractor/types/invalid_product_length.record.yaml +++ b/src/components/ccsds_product_extractor/types/invalid_product_length.record.yaml @@ -1,12 +1,12 @@ --- -description: This record contains information for an event when a product could not be extacted from a packet because the offset and length of the data type exceeded the length of the packet. +description: This record contains information for an event when a product could not be extracted from a packet because the offset and length of the data type exceeded the length of the packet. fields: - name: Id description: The data product Id that was attempted to be extracted. type: Data_Product_Types.Data_Product_Id format: U16 - name: Apid - description: The Apid of the packet that the data product could not be extacted from + description: The Apid of the packet that the data product could not be extracted from type: Ccsds_Primary_Header.Ccsds_Apid_Type format: U16 - name: Length diff --git a/src/components/ccsds_router/ccsds_router.component.yaml b/src/components/ccsds_router/ccsds_router.component.yaml index 106f735b..86064fcf 100644 --- a/src/components/ccsds_router/ccsds_router.component.yaml +++ b/src/components/ccsds_router/ccsds_router.component.yaml @@ -1,6 +1,6 @@ --- description: | - This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a seperate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. + This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a separate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. Note, a race condition exists if packets of the same APID come in simultaneously on both the sync and async CCSDS connectors, and sequence counts are being checked, where the sequence count checking might get corrupted. This use case is not foreseen as actually happening, so complicating the component with protected objects seems unnecessary. diff --git a/src/components/ccsds_router/doc/ccsds_router_context.tex b/src/components/ccsds_router/doc/ccsds_router_context.tex index 5ebd75d4..e02cd58c 100644 --- a/src/components/ccsds_router/doc/ccsds_router_context.tex +++ b/src/components/ccsds_router/doc/ccsds_router_context.tex @@ -9,7 +9,7 @@ In the above context diagram the CCSDS Router is made passive. This means that any CCSDS packet passed to it will be routed on the thread of the calling component, since the calling component uses the \texttt{Ccsds\_Space\_Packet\_Recv\_Sync} connector. -Sometimes it is desireable to do the routing on a different thread of execution to decouple this processing from work going on upstream of the component. The most obvious way to accomplish this is to make the CCSDS Router component active, so it has its own thread of execution. The context diagram below shows this setup. +Sometimes it is desirable to do the routing on a different thread of execution to decouple this processing from work going on upstream of the component. The most obvious way to accomplish this is to make the CCSDS Router component active, so it has its own thread of execution. The context diagram below shows this setup. \begin{figure}[H] \includegraphics[width=0.9\textwidth,center]{assembly/build/eps/context_active.eps} @@ -25,4 +25,4 @@ \caption{Example usage of a passive CCSDS Router which routes packets on the thread of its caller.} \end{figure} -Note, there is a limitation with this use case. A CCSDS packet with the same APID should not be sent through both the synchronous and asyncronous invokee connectors at the same time if sequence number checking is enabled. Since the router table is not a protected object this could produce errant warnings about sequence number tracking, since it is expected that two updates to the sequence numbers tracked in this table will not occur to the same APID at the same time. There has been no real world use case identified which would require that the internal table become a protected object. If a use case is identified, this issue can be revisited. +Note, there is a limitation with this use case. A CCSDS packet with the same APID should not be sent through both the synchronous and asynchronous invokee connectors at the same time if sequence number checking is enabled. Since the router table is not a protected object this could produce errant warnings about sequence number tracking, since it is expected that two updates to the sequence numbers tracked in this table will not occur to the same APID at the same time. There has been no real world use case identified which would require that the internal table become a protected object. If a use case is identified, this issue can be revisited. diff --git a/src/components/ccsds_router/test/component-ccsds_router-implementation-tester.ads b/src/components/ccsds_router/test/component-ccsds_router-implementation-tester.ads index 0f37bbf6..e4357e94 100644 --- a/src/components/ccsds_router/test/component-ccsds_router-implementation-tester.ads +++ b/src/components/ccsds_router/test/component-ccsds_router-implementation-tester.ads @@ -16,7 +16,7 @@ with Unexpected_Sequence_Count.Representation; with Packet; with History; --- This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a seperate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. +-- This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a separate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. -- -- Note, a race condition exists if packets of the same APID come in simultaneously on both the sync and async CCSDS connectors, and sequence counts are being checked, where the sequence count checking might get corrupted. This use case is not foreseen as actually happening, so complicating the component with protected objects seems unnecessary. -- diff --git a/src/components/ccsds_router/test_unrecognized_apid/component-ccsds_router-implementation-tester.ads b/src/components/ccsds_router/test_unrecognized_apid/component-ccsds_router-implementation-tester.ads index 73c08493..6d9146cd 100644 --- a/src/components/ccsds_router/test_unrecognized_apid/component-ccsds_router-implementation-tester.ads +++ b/src/components/ccsds_router/test_unrecognized_apid/component-ccsds_router-implementation-tester.ads @@ -15,7 +15,7 @@ with Ccsds_Primary_Header.Representation; with Unexpected_Sequence_Count.Representation; with Packet; --- This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a seperate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. +-- This component routes CCSDS packets to output connectors based on a static table matching APID to the output connector index. Table lookup is done by binary searching against APID. The look up returns a list of indexes which to route that packet. This component can receive packets either synchronously, or asynchronously and can be made either active or passive depending on the desired use case. If a packet is received with an APID not found in the routing table then it is forwarded out a separate CCSDS connector, if it is connected. In addition to routing, this component can be configured to check the sequence counts on incoming packets, report discontiguous sequence counts, and drop duplicates. -- -- Note, a race condition exists if packets of the same APID come in simultaneously on both the sync and async CCSDS connectors, and sequence counts are being checked, where the sequence count checking might get corrupted. This use case is not foreseen as actually happening, so complicating the component with protected objects seems unnecessary. -- diff --git a/src/components/ccsds_serial_interface/ccsds_serial_interface.component.yaml b/src/components/ccsds_serial_interface/ccsds_serial_interface.component.yaml index 042674b6..88da576b 100644 --- a/src/components/ccsds_serial_interface/ccsds_serial_interface.component.yaml +++ b/src/components/ccsds_serial_interface/ccsds_serial_interface.component.yaml @@ -4,7 +4,7 @@ description: | execution: active subtasks: - name: Listener - description: This internal task is used to listen on the serial port for incomming packets. + description: This internal task is used to listen on the serial port for incoming packets. connectors: - description: On this connector the Socket Interface Component receives data and sends it out of the socket. type: Ccsds_Space_Packet.T diff --git a/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.adb b/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.adb index 28fba2e4..f10041b8 100644 --- a/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.adb +++ b/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.adb @@ -62,7 +62,7 @@ package body Component.Ccsds_Serial_Interface.Implementation is ------------------------------------------------------- -- Definition of subtasks functions for task execution: ------------------------------------------------------- - -- This internal task is used to listen on the serial port for incomming packets. + -- This internal task is used to listen on the serial port for incoming packets. overriding procedure Listener (Self : in out Instance) is use Interfaces; A_Byte : Basic_Types.Byte; diff --git a/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.ads b/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.ads index c259732a..3f866d47 100644 --- a/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.ads +++ b/src/components/ccsds_serial_interface/component-ccsds_serial_interface-implementation.ads @@ -45,7 +45,7 @@ private ------------------------------------------------------- -- Definition of subtasks functions for task execution: ------------------------------------------------------- - -- This internal task is used to listen on the serial port for incomming packets. + -- This internal task is used to listen on the serial port for incoming packets. -- IMPORTANT: This component needs an inner task to run the -- following function as if it were the "cycle" method of -- a normal component. The "cycle" method of this component diff --git a/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface.tests.yaml b/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface.tests.yaml index a87d21e7..5aff09fe 100644 --- a/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface.tests.yaml +++ b/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface.tests.yaml @@ -2,4 +2,4 @@ description: This is the packet send unit test suite for the Serial Interface Component tests: - name: Test_Packet_Receive - description: This unit test makes sure that packets received through the serial port are fowarded through the send connector. This test excersizes the additional internal task of the Socket Interface Component. + description: This unit test makes sure that packets received through the serial port are forwarded through the send connector. This test exercises the additional internal task of the Socket Interface Component. diff --git a/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface_tests-implementation.ads b/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface_tests-implementation.ads index 66cd139a..663fabd2 100644 --- a/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface_tests-implementation.ads +++ b/src/components/ccsds_serial_interface/test_read/ccsds_serial_interface_tests-implementation.ads @@ -11,7 +11,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test makes sure that packets received through the serial port are fowarded through the send connector. This test excersizes the additional internal task of the Socket Interface Component. + -- This unit test makes sure that packets received through the serial port are forwarded through the send connector. This test exercises the additional internal task of the Socket Interface Component. overriding procedure Test_Packet_Receive (Self : in out Instance); -- Test data and state: diff --git a/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface.tests.yaml b/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface.tests.yaml index 811bd5dd..5c3210bb 100644 --- a/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface.tests.yaml +++ b/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface.tests.yaml @@ -2,4 +2,4 @@ description: This is the packet send unit test suite for the Serial Interface Component tests: - name: Test_Packet_Send - description: This unit makes sure that packets sent through the component's queue are fowarded through the socket. + description: This unit makes sure that packets sent through the component's queue are forwarded through the socket. diff --git a/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface_tests-implementation.ads b/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface_tests-implementation.ads index 0fecabf5..f5e5f4de 100644 --- a/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface_tests-implementation.ads +++ b/src/components/ccsds_serial_interface/test_write/ccsds_serial_interface_tests-implementation.ads @@ -11,7 +11,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit makes sure that packets sent through the component's queue are fowarded through the socket. + -- This unit makes sure that packets sent through the component's queue are forwarded through the socket. overriding procedure Test_Packet_Send (Self : in out Instance); -- Test data and state: diff --git a/src/components/ccsds_socket_interface/ccsds_socket_interface.component.yaml b/src/components/ccsds_socket_interface/ccsds_socket_interface.component.yaml index fbfa9f39..6626a749 100644 --- a/src/components/ccsds_socket_interface/ccsds_socket_interface.component.yaml +++ b/src/components/ccsds_socket_interface/ccsds_socket_interface.component.yaml @@ -1,6 +1,6 @@ --- description: | - The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and recieve connectors are CCSDS. + The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and receive connectors are CCSDS. execution: active init: description: This initialization subprogram connects the component to a TCP socket on the given address and port. @@ -15,7 +15,7 @@ init: description: The port that the component should connect to. subtasks: - name: Listener - description: This internal task is used to listen on the socket for incomming packets. + description: This internal task is used to listen on the socket for incoming packets. connectors: - description: On this connector the Socket Interface Component receives data and sends it out of the socket. type: Ccsds_Space_Packet.T diff --git a/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.adb b/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.adb index e6053fc5..c29d2d2c 100644 --- a/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.adb +++ b/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.adb @@ -89,7 +89,7 @@ package body Component.Ccsds_Socket_Interface.Implementation is ------------------------------------------------------- -- Definition of subtasks functions for task execution: ------------------------------------------------------- - -- This internal task is used to listen on the socket for incomming packets. + -- This internal task is used to listen on the socket for incoming packets. overriding procedure Listener (Self : in out Instance) is use Ada.Real_Time; use Serializer_Types; diff --git a/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.ads b/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.ads index 94f3871b..b42346ce 100644 --- a/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.ads +++ b/src/components/ccsds_socket_interface/component-ccsds_socket_interface-implementation.ads @@ -6,7 +6,7 @@ -- Invokee Connector Includes: with Socket; --- The Socket Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and recieve connectors are of a generic buffer type, Com_Packet, so that data of an arbitrary format can be sent via this component. +-- The Socket Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and receive connectors are of a generic buffer type, Com_Packet, so that data of an arbitrary format can be sent via this component. -- package Component.Ccsds_Socket_Interface.Implementation is @@ -47,7 +47,7 @@ private ------------------------------------------------------- -- Definition of subtasks functions for task execution: ------------------------------------------------------- - -- This internal task is used to listen on the socket for incomming packets. + -- This internal task is used to listen on the socket for incoming packets. -- IMPORTANT: This component needs an inner task to run the -- following function as if it were the "cycle" method of -- a normal component. The "cycle" method of this component diff --git a/src/components/ccsds_socket_interface/test_read/component-ccsds_socket_interface-implementation-tester.ads b/src/components/ccsds_socket_interface/test_read/component-ccsds_socket_interface-implementation-tester.ads index 1836c109..b9ef3a9f 100644 --- a/src/components/ccsds_socket_interface/test_read/component-ccsds_socket_interface-implementation-tester.ads +++ b/src/components/ccsds_socket_interface/test_read/component-ccsds_socket_interface-implementation-tester.ads @@ -11,7 +11,7 @@ with Event; with Socket_Address; with Ccsds_Primary_Header; --- The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and recieve connectors are CCSDS. +-- The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and receive connectors are CCSDS. -- package Component.Ccsds_Socket_Interface.Implementation.Tester is diff --git a/src/components/ccsds_socket_interface/test_read/tests-implementation.ads b/src/components/ccsds_socket_interface/test_read/tests-implementation.ads index f947bb9a..c6befd51 100644 --- a/src/components/ccsds_socket_interface/test_read/tests-implementation.ads +++ b/src/components/ccsds_socket_interface/test_read/tests-implementation.ads @@ -12,7 +12,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test makes sure that packets received through the socket are fowarded through the send connector. This test excersizes the additional internal task of the Socket Interface Component. + -- This unit test makes sure that packets received through the socket are forwarded through the send connector. This test exercises the additional internal task of the Socket Interface Component. overriding procedure Test_Packet_Receive (Self : in out Instance); -- Test data and state: diff --git a/src/components/ccsds_socket_interface/test_read/tests.ccsds_socket_interface.tests.yaml b/src/components/ccsds_socket_interface/test_read/tests.ccsds_socket_interface.tests.yaml index c7f89ce9..062730bc 100644 --- a/src/components/ccsds_socket_interface/test_read/tests.ccsds_socket_interface.tests.yaml +++ b/src/components/ccsds_socket_interface/test_read/tests.ccsds_socket_interface.tests.yaml @@ -2,4 +2,4 @@ description: This is the packet send unit test suite for the Socket Interface Component tests: - name: Test_Packet_Receive - description: This unit test makes sure that packets received through the socket are fowarded through the send connector. This test excersizes the additional internal task of the Socket Interface Component. + description: This unit test makes sure that packets received through the socket are forwarded through the send connector. This test exercises the additional internal task of the Socket Interface Component. diff --git a/src/components/ccsds_socket_interface/test_write/component-ccsds_socket_interface-implementation-tester.ads b/src/components/ccsds_socket_interface/test_write/component-ccsds_socket_interface-implementation-tester.ads index 9c4e90db..c845870f 100644 --- a/src/components/ccsds_socket_interface/test_write/component-ccsds_socket_interface-implementation-tester.ads +++ b/src/components/ccsds_socket_interface/test_write/component-ccsds_socket_interface-implementation-tester.ads @@ -12,7 +12,7 @@ with Event; with Socket_Address.Representation; with Ccsds_Primary_Header.Representation; --- The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and recieve connectors are CCSDS. +-- The Socket Interface Component is an interface component which connects the rest of the assembly to an outside entity (usually the ground system) via a TCP/IP socket. It spawns an internal task to listen to the socket for incoming data. It also provides an asynchronous receive connector which it services on it's task, sending any data it receives out of the socket. The data send and receive connectors are CCSDS. package Component.Ccsds_Socket_Interface.Implementation.Tester is use Component.Ccsds_Socket_Interface_Reciprocal; diff --git a/src/components/ccsds_socket_interface/test_write/tests-implementation.ads b/src/components/ccsds_socket_interface/test_write/tests-implementation.ads index e2f24edc..25bbf07a 100644 --- a/src/components/ccsds_socket_interface/test_write/tests-implementation.ads +++ b/src/components/ccsds_socket_interface/test_write/tests-implementation.ads @@ -12,7 +12,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit makes sure that packets sent through the component's queue are fowarded through the socket. + -- This unit makes sure that packets sent through the component's queue are forwarded through the socket. overriding procedure Test_Packet_Send (Self : in out Instance); -- Test data and state: diff --git a/src/components/ccsds_socket_interface/test_write/tests.ccsds_socket_interface.tests.yaml b/src/components/ccsds_socket_interface/test_write/tests.ccsds_socket_interface.tests.yaml index 0979c9e0..b93b390e 100644 --- a/src/components/ccsds_socket_interface/test_write/tests.ccsds_socket_interface.tests.yaml +++ b/src/components/ccsds_socket_interface/test_write/tests.ccsds_socket_interface.tests.yaml @@ -2,4 +2,4 @@ description: This is the packet send unit test suite for the Socket Interface Component tests: - name: Test_Packet_Send - description: This unit makes sure that packets sent through the component's queue are fowarded through the socket. + description: This unit makes sure that packets sent through the component's queue are forwarded through the socket. diff --git a/src/components/ccsds_subpacket_extractor/ccsds_subpacket_extractor.requirements.yaml b/src/components/ccsds_subpacket_extractor/ccsds_subpacket_extractor.requirements.yaml index dbe2905d..78095678 100644 --- a/src/components/ccsds_subpacket_extractor/ccsds_subpacket_extractor.requirements.yaml +++ b/src/components/ccsds_subpacket_extractor/ccsds_subpacket_extractor.requirements.yaml @@ -2,5 +2,5 @@ description: The requirements for the CCSDS Subpacket Extractor component are specified below. requirements: - text: The component shall extract CCSDS subpackets from a received CCSDS packet. - - text: The component shall drop unsuccessfully extracted CCSDS subpackets and report the occurence in an event. + - text: The component shall drop unsuccessfully extracted CCSDS subpackets and report the occurrence in an event. - text: The component shall package and send unsuccessfully extracted CCSDS subpackets as error packets. diff --git a/src/components/ccsds_subpacket_extractor/doc/ccsds_subpacket_extractor_context.tex b/src/components/ccsds_subpacket_extractor/doc/ccsds_subpacket_extractor_context.tex index 16ff1f61..7d533e24 100644 --- a/src/components/ccsds_subpacket_extractor/doc/ccsds_subpacket_extractor_context.tex +++ b/src/components/ccsds_subpacket_extractor/doc/ccsds_subpacket_extractor_context.tex @@ -9,7 +9,7 @@ In the above context diagram the CCSDS Subpacket Extractor is made passive. This means that any CCSDS packet passed to it will be subpacket extracted on the thread of the calling component, since the calling component uses the \texttt{Ccsds\_Space\_Packet\_Recv\_Sync} connector. -Sometimes it is desireable to do the extracting on a different thread of execution to decouple this processing from work going on upstream of the component. The most obvious way to accomplish this is to make the CCSDS Subpacket Extractor component active, so it has its own thread of execution. The context diagram below shows this setup. +Sometimes it is desirable to do the extracting on a different thread of execution to decouple this processing from work going on upstream of the component. The most obvious way to accomplish this is to make the CCSDS Subpacket Extractor component active, so it has its own thread of execution. The context diagram below shows this setup. \begin{figure}[H] \includegraphics[width=0.9\textwidth,center]{assembly/build/eps/context_active.eps} diff --git a/src/components/ccsds_subpacket_extractor/test/ccsds_subpacket_extractor_tests-implementation.adb b/src/components/ccsds_subpacket_extractor/test/ccsds_subpacket_extractor_tests-implementation.adb index ecad56e6..67dfb0c7 100644 --- a/src/components/ccsds_subpacket_extractor/test/ccsds_subpacket_extractor_tests-implementation.adb +++ b/src/components/ccsds_subpacket_extractor/test/ccsds_subpacket_extractor_tests-implementation.adb @@ -338,7 +338,7 @@ package body Ccsds_Subpacket_Extractor_Tests.Implementation is Packet.Header.Packet_Length := Packet.Header.Packet_Length + 1; T.Ccsds_Space_Packet_T_Send (Packet); - -- Expect 2 packets to be extacted correctly: + -- Expect 2 packets to be extracted correctly: Natural_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get_Count, 2); Ccsds_Space_Packet_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get (1), Packet_1); Ccsds_Space_Packet_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get (2), Packet_3); @@ -359,7 +359,7 @@ package body Ccsds_Subpacket_Extractor_Tests.Implementation is T.Ccsds_Space_Packet_T_Send_2 (Packet); Natural_Assert.Eq (Self.Tester.Dispatch_All, 1); - -- Expect 1 packet to be extacted correctly: + -- Expect 1 packet to be extracted correctly: Natural_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get_Count, 3); Ccsds_Space_Packet_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get (3), Packet_3); @@ -448,7 +448,7 @@ package body Ccsds_Subpacket_Extractor_Tests.Implementation is Packet.Header.Packet_Length := Packet.Header.Packet_Length + 1; T.Ccsds_Space_Packet_T_Send (Packet); - -- Expect 2 packets to be extacted correctly: + -- Expect 2 packets to be extracted correctly: Natural_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get_Count, 7); Ccsds_Space_Packet_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get (6), Packet_1); Ccsds_Space_Packet_Assert.Eq (T.Ccsds_Space_Packet_T_Recv_Sync_History.Get (7), Packet_3); diff --git a/src/components/command_protector/arm_state/arm_state.adb b/src/components/command_protector/arm_state/arm_state.adb index 6abb8afd..f095be42 100644 --- a/src/components/command_protector/arm_state/arm_state.adb +++ b/src/components/command_protector/arm_state/arm_state.adb @@ -23,7 +23,7 @@ package body Arm_State is Timeout := New_Timeout; end Arm; - -- Unarm the system and cancel the timout: + -- Unarm the system and cancel the timeout: procedure Unarm is use Packed_Arm_Timeout; begin diff --git a/src/components/command_protector/arm_state/arm_state.ads b/src/components/command_protector/arm_state/arm_state.ads index 9bf02ff3..bc628bc5 100644 --- a/src/components/command_protector/arm_state/arm_state.ads +++ b/src/components/command_protector/arm_state/arm_state.ads @@ -17,7 +17,7 @@ package Arm_State is -- -- Arm the system and provide a timeout value: procedure Arm (New_Timeout : in Packed_Arm_Timeout.Arm_Timeout_Type); - -- Unarm the system and cancel the timout: + -- Unarm the system and cancel the timeout: procedure Unarm; -- Decrement the timeout, and transition to the unarmed state if the -- timeout has expired. diff --git a/src/components/command_protector/types/packed_arm_timeout.record.yaml b/src/components/command_protector/types/packed_arm_timeout.record.yaml index dc2c7778..9592c134 100644 --- a/src/components/command_protector/types/packed_arm_timeout.record.yaml +++ b/src/components/command_protector/types/packed_arm_timeout.record.yaml @@ -1,5 +1,5 @@ --- -description: Holds the armed state timout. +description: Holds the armed state timeout. preamble: | type Arm_Timeout_Type is new Natural range 0 .. 255; fields: diff --git a/src/components/command_router/command_router.component.yaml b/src/components/command_router/command_router.component.yaml index 1f15fd2e..0029d320 100644 --- a/src/components/command_router/command_router.component.yaml +++ b/src/components/command_router/command_router.component.yaml @@ -15,11 +15,11 @@ init: type: Natural description: The maximum number of unique commands that can be registered with the command router component. connectors: - - description: On this connector the Command Router recieves incoming commands that need to be routed to the correct destination component. + - description: On this connector the Command Router receives incoming commands that need to be routed to the correct destination component. type: Command.T kind: recv_async name: Command_T_To_Route_Recv_Async - - description: On this connector the Command Router recieves incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue that the Command_T_To_Route_Recv_Async uses. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. + - description: On this connector the Command Router receives incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue that the Command_T_To_Route_Recv_Async uses. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. type: Command.T kind: recv_sync name: Command_T_To_Route_Recv_Sync @@ -27,7 +27,7 @@ connectors: type: Command.T kind: send count: 0 # size determined by assembly - - description: Command registrations are received on this connector during initialization. Command responses from connected components are recieved on this connector during execution. + - description: Command registrations are received on this connector during initialization. Command responses from connected components are received on this connector during execution. type: Command_Response.T kind: recv_async - description: Command responses received from command executing components are forwarded back to their command sources using this arrayed connector. One index of this connector can be connected in loopback to the Command_Response_T_Recv_Async connector in order to command forwarding self test capabilities (see the Noop_Response command). @@ -35,7 +35,7 @@ connectors: type: Command_Response.T kind: send count: 0 # size determined by assembly - - description: This is the command recieve connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. + - description: This is the command receive connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. type: Command.T kind: recv_async - description: This connector is used to register the Command Router's NOOP commands at initialization, and respond to NOOP commands during ececution. It is usually connected in loopback to the Command_Response_T_Recv_Async connector. diff --git a/src/components/command_router/component-command_router-implementation.adb b/src/components/command_router/component-command_router-implementation.adb index 133e0ade..fc7adb42 100644 --- a/src/components/command_router/component-command_router-implementation.adb +++ b/src/components/command_router/component-command_router-implementation.adb @@ -75,7 +75,7 @@ package body Component.Command_Router.Implementation is Self.Command_T_To_Route_Recv_Sync (Arg); end Command_T_To_Route_Recv_Async; - -- On this connector the Command Router recieves incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. + -- On this connector the Command Router receives incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. overriding procedure Command_T_To_Route_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Local variables: Send_Index : Command_Types.Command_Registration_Id; @@ -112,7 +112,7 @@ package body Component.Command_Router.Implementation is end case; end Command_T_To_Route_Recv_Sync; - -- This is the command recieve connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. + -- This is the command receive connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); @@ -150,7 +150,7 @@ package body Component.Command_Router.Implementation is end if; end Register_Command; - -- Command registrations are received on this connector during initialization. Command responses from connected components are recieved on this connector during execution. + -- Command registrations are received on this connector during initialization. Command responses from connected components are received on this connector during execution. overriding procedure Command_Response_T_Recv_Async (Self : in out Instance; Arg : in Command_Response.T) is use Command_Response_Status; use Command_Types; @@ -256,7 +256,7 @@ package body Component.Command_Router.Implementation is overriding function Noop_Response (Self : in out Instance) return Command_Execution_Status.E is use Command_Execution_Status; begin - -- Send infomational event saying that we got the command. + -- Send informational event saying that we got the command. Self.Event_T_Send_If_Connected (Self.Events.Noop_Response_Received (Self.Sys_Time_T_Get)); -- OK now start self test by sending a noop command. Self.Command_T_To_Route_Recv_Sync (Self.Commands.Noop); @@ -284,7 +284,7 @@ package body Component.Command_Router.Implementation is Self.Data_Product_T_Send (Self.Data_Products.Noop_Arg_Last_Value (The_Time, (Value => 0))); end if; - -- Send infomational event saying that we got the command. + -- Send informational event saying that we got the command. Self.Event_T_Send_If_Connected (Self.Events.Data_Products_Reset (The_Time)); return Success; @@ -331,7 +331,7 @@ package body Component.Command_Router.Implementation is overriding procedure Command_T_To_Route_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T) is use Command_Response_Status; begin - -- If an incoming command was dropped then the command router itself needs to send a comand response. In this + -- If an incoming command was dropped then the command router itself needs to send a command response. In this -- case, we do this by directly sending the command response to ourself right now. Self.Command_Response_T_Recv_Async (( Source_Id => Arg.Header.Source_Id, diff --git a/src/components/command_router/component-command_router-implementation.ads b/src/components/command_router/component-command_router-implementation.ads index edd25881..3cf2e401 100644 --- a/src/components/command_router/component-command_router-implementation.ads +++ b/src/components/command_router/component-command_router-implementation.ads @@ -60,17 +60,17 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- On this connector the Command Router recieves incoming commands that need to be routed to the correct destination component. + -- On this connector the Command Router receives incoming commands that need to be routed to the correct destination component. overriding procedure Command_T_To_Route_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_To_Route_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_To_Route_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); - -- On this connector the Command Router recieves incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. + -- On this connector the Command Router receives incoming commands that need to be routed to the correct destination component. This connector is synchronous, and thus bypasses the internal queue. It should be used by components that need high priority command execution. It should only be called after command registration has occurred, or a race condition is present. overriding procedure Command_T_To_Route_Recv_Sync (Self : in out Instance; Arg : in Command.T); - -- This is the command recieve connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. + -- This is the command receive connector for the Command Router. The NOOP commands sent on this connector will be executed by the command router. This connector will usually be connected in loopback from the Command_T_Send connector in order to provide aliveness test capabilities, or disconnected completely. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); - -- Command registrations are received on this connector during initialization. Command responses from connected components are recieved on this connector during execution. + -- Command registrations are received on this connector during initialization. Command responses from connected components are received on this connector during execution. overriding procedure Command_Response_T_Recv_Async (Self : in out Instance; Arg : in Command_Response.T); -- This procedure is called when a Command_Response_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_Response_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command_Response.T); diff --git a/src/components/command_router/router_table/test/router_table_tests-implementation.adb b/src/components/command_router/router_table/test/router_table_tests-implementation.adb index a92f1ff2..265fdf8d 100644 --- a/src/components/command_router/router_table/test/router_table_tests-implementation.adb +++ b/src/components/command_router/router_table/test/router_table_tests-implementation.adb @@ -69,7 +69,7 @@ package body Router_Table_Tests.Implementation is Registration_Assert.Eq (Registration_Id, 36); Natural_Assert.Eq (Self.Table.Get_Size, 3); - -- Search table for nonexistant registrations: + -- Search table for nonexistent registrations: Lookup_Assert.Eq (Self.Table.Lookup_Registration_Id (96, Ignore), Router_Table.Id_Not_Found); Natural_Assert.Eq (Self.Table.Get_Size, 3); diff --git a/src/components/command_router/router_table/test/router_table_tests-implementation.ads b/src/components/command_router/router_table/test/router_table_tests-implementation.ads index bfafcb0f..c1cfc3cb 100644 --- a/src/components/command_router/router_table/test/router_table_tests-implementation.ads +++ b/src/components/command_router/router_table/test/router_table_tests-implementation.ads @@ -13,7 +13,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test adds registration elemenents to the router table and asserts for correct response and table structure + -- This unit test adds registration elements to the router table and asserts for correct response and table structure overriding procedure Add_To_Table (Self : in out Instance); -- Test data and state: diff --git a/src/components/command_router/test/command_router.tests.yaml b/src/components/command_router/test/command_router.tests.yaml index 15a1029e..0c05ec6e 100644 --- a/src/components/command_router/test/command_router.tests.yaml +++ b/src/components/command_router/test/command_router.tests.yaml @@ -2,9 +2,9 @@ description: This is a unit test suite for the Command Router component tests: - name: Test_Nominal_Routing - description: This unit test excersizes command routing via the Command Router internal commands. + description: This unit test exercises command routing via the Command Router internal commands. - name: Test_Nominal_Registration - description: This unit test excersizes command registration from the external testing component, and then makes sure the command routing works. + description: This unit test exercises command registration from the external testing component, and then makes sure the command routing works. - name: Test_Routing_Errors description: This unit test makes sure errors are thrown when unknown commands are sent. - name: Test_Registration_Errors diff --git a/src/components/command_router/test/command_router_tests-implementation.adb b/src/components/command_router/test/command_router_tests-implementation.adb index 06b12e4e..90a78e88 100644 --- a/src/components/command_router/test/command_router_tests-implementation.adb +++ b/src/components/command_router/test/command_router_tests-implementation.adb @@ -789,7 +789,7 @@ package body Command_Router_Tests.Implementation is Command_Response.Assertion.Command_Response_Assert.Eq (T.Command_Response_T_To_Forward_Recv_Sync_History.Get (3), (Source_Id => 2, Registration_Id => 2, Command_Id => 27, Status => Success)); Command_Response.Assertion.Command_Response_Assert.Eq (T.Command_Response_T_To_Forward_Recv_Sync_History.Get (4), (Source_Id => 3, Registration_Id => 3, Command_Id => 15, Status => Failure)); - -- Send a commmand response with zero. Expect nothing to be forwarded. + -- Send a command response with zero. Expect nothing to be forwarded. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 3, Command_Id => 15, Status => Register)); T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 3, Command_Id => 15, Status => Register)); T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 3, Command_Id => 15, Status => Register)); diff --git a/src/components/command_router/test/command_router_tests-implementation.ads b/src/components/command_router/test/command_router_tests-implementation.ads index c182154f..f52d23e3 100644 --- a/src/components/command_router/test/command_router_tests-implementation.ads +++ b/src/components/command_router/test/command_router_tests-implementation.ads @@ -11,9 +11,9 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes command routing via the Command Router internal commands. + -- This unit test exercises command routing via the Command Router internal commands. overriding procedure Test_Nominal_Routing (Self : in out Instance); - -- This unit test excersizes command registration from the external testing component, and then makes sure the command routing works. + -- This unit test exercises command registration from the external testing component, and then makes sure the command routing works. overriding procedure Test_Nominal_Registration (Self : in out Instance); -- This unit test makes sure errors are thrown when unknown commands are sent. overriding procedure Test_Routing_Errors (Self : in out Instance); diff --git a/src/components/command_sequencer/command_sequencer.component.yaml b/src/components/command_sequencer/command_sequencer.component.yaml index 59bc2fe1..25ae782d 100644 --- a/src/components/command_sequencer/command_sequencer.component.yaml +++ b/src/components/command_sequencer/command_sequencer.component.yaml @@ -2,7 +2,7 @@ description: | The Command Sequencer component executes command sequences with a configurable number of engines. The sequence engines execute sequences in the LASP Awesome Sequence Engine Language (LASEL) compiled by the LASP SEQ tool. Documentation on LASEL is included in this component's doc/ directory. - This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precendence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceding. + This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precedence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceeding. The sequence engine and sequence runtime (LASEL interpreter) is located in the seq/ directory. execution: active diff --git a/src/components/command_sequencer/command_sequencer.events.yaml b/src/components/command_sequencer/command_sequencer.events.yaml index 550e6e46..54cdc4c6 100644 --- a/src/components/command_sequencer/command_sequencer.events.yaml +++ b/src/components/command_sequencer/command_sequencer.events.yaml @@ -45,7 +45,7 @@ events: - name: Killed_All_Engines description: A command was executed to kill all running sequences. - name: Killed_Engine - description: A command was executed to kill a sequence running in a specic engine + description: A command was executed to kill a sequence running in a specific engine param_type: Packed_Sequence_Engine_Id.T - name: Dropped_Command description: A command was dropped due to a full queue. @@ -69,7 +69,7 @@ events: description: An extra source registration was received, but all engines have a source ID already. param_type: Command_Response.T - name: Sequence_Execution_Error - description: An error occured while executing a sequence. + description: An error occurred while executing a sequence. param_type: Engine_Error_Type.T - name: Sequence_Timeout_Error description: A sequence timed out waiting on a command response of subsequence load. diff --git a/src/components/command_sequencer/component-command_sequencer-implementation.adb b/src/components/command_sequencer/component-command_sequencer-implementation.adb index e94f422d..a6deefd2 100644 --- a/src/components/command_sequencer/component-command_sequencer-implementation.adb +++ b/src/components/command_sequencer/component-command_sequencer-implementation.adb @@ -437,7 +437,7 @@ package body Component.Command_Sequencer.Implementation is -- Grab the current time after execution. Current_Time : constant Sys_Time.T := Self.Sys_Time_T_Get; -- Define the recursion limit as related to the number of engines. This allows someone to write a sequence that - -- kills each engine one after another using a single "kill" command. We set minumum to 10. This also allows at + -- kills each engine one after another using a single "kill" command. We set minimum to 10. This also allows at -- least 10 print statements in a row. Recursion_Limit : constant Natural := Natural'Max (Self.Seq_Engines.all'Length + 1, 10); begin @@ -497,7 +497,7 @@ package body Component.Command_Sequencer.Implementation is -- sequence into any currently available engine. Otherwise, let's range check the engine. if Destination_Engine_Id /= Engine.Get_Engine_Id then if Destination_Engine_Id = 255 then - -- Seach for an available engine and use the first one we find. + -- Search for an available engine and use the first one we find. declare Available_Engine_Id : Seq_Types.Sequence_Engine_Id; Engine_Available : constant Boolean := Self.Find_Available_Engine (Available_Engine_Id); @@ -763,7 +763,7 @@ package body Component.Command_Sequencer.Implementation is when Wait_Relative | Wait_Telemetry_Relative | Wait_Absolute | Kill_Engines | Print => pragma Assert (False); - -- These waits all require timeout logic to be excersized. + -- These waits all require timeout logic to be exercised. when Wait_Command | Wait_Load_Seq => -- Check for a timeout: if not Self.Increment_Timeout (Engine) then @@ -1328,7 +1328,7 @@ package body Component.Command_Sequencer.Implementation is begin -- This implementation assumes that the variable array is of length 16 and the number -- of arguments provided in Packed_Variable_Array.T is also 16. If this is not true, then - -- both types and the copy code below need to be updated to be consistant. + -- both types and the copy code below need to be updated to be consistent. pragma Compile_Time_Error (Variable_Array'Length /= 16, "Expected variable length array to be 16."); -- Now load the arguments in one at a time. An assertion diff --git a/src/components/command_sequencer/component-command_sequencer-implementation.ads b/src/components/command_sequencer/component-command_sequencer-implementation.ads index d9ec28c5..5ffd12d6 100644 --- a/src/components/command_sequencer/component-command_sequencer-implementation.ads +++ b/src/components/command_sequencer/component-command_sequencer-implementation.ads @@ -12,7 +12,7 @@ with Seq_Types; -- The Command Sequencer component executes command sequences with a configurable number of engines. The sequence engines execute sequences in the LASP Awesome Sequence Engine Language (LASEL) compiled by the LASP SEQ tool. Documentation on LASEL is included in this component's doc/ directory. -- --- This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precendence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceding. +-- This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precedence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceeding. -- -- The sequence engine and LASEL interpreter is located in the seq/ directory. package Component.Command_Sequencer.Implementation is @@ -43,7 +43,7 @@ private type Seq_Engine_Array is array (Seq_Types.Sequence_Engine_Id range <>) of Seq.Engine; type Seq_Engine_Array_Access is access all Seq_Engine_Array; - -- Create a type for auxillary data for each sequence engine. This holds information + -- Create a type for auxiliary data for each sequence engine. This holds information -- about each sequence engine that is not held within the engine type itself. type Engine_Aux_Data_Type is record -- Timeout counter - this helps the component timeout while waiting on a specific @@ -63,7 +63,7 @@ private -- Maximum number of instructions that can be executed without a pausing action. Prevents -- infinite loops within a running sequence. Instruction_Limit : Positive := Positive'Last; - -- Maximum number ot ticks to spend waiting on command responses and subsequence loads. A + -- Maximum number of ticks to spend waiting on command responses and subsequence loads. A -- timeout results in a transition of the engine to an error state. Timeout_Limit : Natural := Natural'First; -- Configuration which determines whether or not an engine continues to execute after a diff --git a/src/components/command_sequencer/seq/engine/seq.ads b/src/components/command_sequencer/seq/engine/seq.ads index bf9befc3..f5e78a3f 100644 --- a/src/components/command_sequencer/seq/engine/seq.ads +++ b/src/components/command_sequencer/seq/engine/seq.ads @@ -13,7 +13,7 @@ with Interfaces; use Interfaces; with Seq_Print; -- This package implements a sequence engine which is designed to run a single sequence at a time. It includes --- a stack that allows sequences to "call" eachother up to a depth limit set at initialization. +-- a stack that allows sequences to "call" each other up to a depth limit set at initialization. package Seq is use Seq_Engine_State; use Seq_Runtime_State; @@ -70,7 +70,7 @@ package Seq is -- Get the state of the currently running sequence. function Get_Running_Sequence_State (Self : in Engine) return Seq_Enums.Seq_Runtime_State.E; - -- Get the currenty deepest allocated level in the stack. 0 means that the highest level + -- Get the currently deepest allocated level in the stack. 0 means that the highest level -- sequence is running. function Get_Stack_Level (Self : in Engine) return Max_Seq_Num; @@ -174,7 +174,7 @@ package Seq is -- Return the runtime state of the sequence at the specified stack index. function Get_Sequence_State (Self : in Engine; Index : in Max_Seq_Num) return Seq_Runtime_State.E; - -- Return state after the last exection of the sequence at the specified stack index. + -- Return state after the last execution of the sequence at the specified stack index. function Get_Last_Execute_State (Self : in Engine) return Seq_Execute_State.E; -- Return memory region containing the sequence at the specified stack index. diff --git a/src/components/command_sequencer/seq/runtime/seq_runtime.adb b/src/components/command_sequencer/seq/runtime/seq_runtime.adb index 10022ebf..36981e8d 100644 --- a/src/components/command_sequencer/seq/runtime/seq_runtime.adb +++ b/src/components/command_sequencer/seq/runtime/seq_runtime.adb @@ -250,7 +250,7 @@ package body Seq_Runtime is end Check_Wake; -- Takes arguments in and updates the local var array. - -- The runtime must be unloaded for this function call to be successfull + -- The runtime must be unloaded for this function call to be successful procedure Give_Arguments (Self : in out Instance; Args : in Variable_Array) is begin Self.Local_Variable_Array := Args; @@ -551,7 +551,7 @@ package body Seq_Runtime is return Self.Cmd_Jump_Not_Zero; when Jump_If_Equal => return Self.Cmd_Jump_If_Equal; - -- This is not coverable currently because the sequencer has no statments that compile + -- This is not coverable currently because the sequencer has no statements that compile -- this instruction in. Adamant does support it however. when Jump_Not_Equal => return Self.Cmd_Jump_Not_Equal; @@ -567,7 +567,7 @@ package body Seq_Runtime is return Self.Position + 4; when Eval_Flt => return Self.Cmd_Eval_Flt; - -- This instruction is currently dissallowed in the Adamant compiler, + -- This instruction is currently disallowed in the Adamant compiler, -- so it is not coverable. The instruction is implemented however, and this -- feature can be supported by simply allowing this instruction in the compiler. when Cast_F_To_U => @@ -580,7 +580,7 @@ package body Seq_Runtime is return Self.Cmd_Cast_S_To_U; when Cast_U_To_S => return Self.Cmd_Cast_U_To_S; - -- This instruction is currently dissallowed in the Adamant compiler, + -- This instruction is currently disallowed in the Adamant compiler, -- so it is not coverable. The instruction is implemented however, and this -- feature can be supported by simply allowing this instruction in the compiler. when Cast_F_To_S => diff --git a/src/components/command_sequencer/seq/runtime/seq_runtime.ads b/src/components/command_sequencer/seq/runtime/seq_runtime.ads index c28a76ca..c61bb11d 100644 --- a/src/components/command_sequencer/seq/runtime/seq_runtime.ads +++ b/src/components/command_sequencer/seq/runtime/seq_runtime.ads @@ -97,7 +97,7 @@ package Seq_Runtime is Self.Get_State = Wait_Load_New_Seq_Elsewhere; -- If a "spawn" instruction is encountered, this function will return the destination engine that the - -- new sequence shouod be spawned into. + -- new sequence should be spawned into. function Get_Spawn_Destination (Self : in Instance) return Sequence_Engine_Id with Pre => Self.Get_State = Wait_Load_New_Seq_Elsewhere; diff --git a/src/components/command_sequencer/seq/simulator/main.adb b/src/components/command_sequencer/seq/simulator/main.adb index 650bf330..a63fc8de 100644 --- a/src/components/command_sequencer/seq/simulator/main.adb +++ b/src/components/command_sequencer/seq/simulator/main.adb @@ -28,7 +28,7 @@ begin Define_Switch (Config, Num_Engines'Access, "-n:", Long_Switch => "--num_engines:", Help => "The number of sequence engines to include in the simulator (default 1)."); Define_Switch (Config, Stack_Depth'Access, "-s:", Long_Switch => "--stack_depth:", Help => "The stack depth to include in each simulator sequence engine (default 1)."); Define_Switch (Config, Initial_Load'Access, "-e:", Long_Switch => "--engine_to_load:", Help => "The engine to load the sequence into (default 0)."); - Define_Switch (Config, Start_Source_Id'Access, "-i:", Long_Switch => "--start_source_id:", Help => "The engine command srouce ID to load into the first engine (default 0). Each subsequent engine will have an incremented command source ID starting at this value."); + Define_Switch (Config, Start_Source_Id'Access, "-i:", Long_Switch => "--start_source_id:", Help => "The engine command source ID to load into the first engine (default 0). Each subsequent engine will have an incremented command source ID starting at this value."); Define_Switch (Config, Start_Time'Access, "-t:", Long_Switch => "--start_time:", Help => "The simulator absolute start time in seconds (default 0)."); Define_Switch (Config, Config_Filename_Access'Access, "-c:", Long_Switch => "--config:", Help => "The sequence builder configuration file that defines commands and telemetry."); Define_Switch (Config, Ignore'Access, "-d:", Help => "This switch is unused, but used to maintain compatibility with the original SEQ implementation."); @@ -70,7 +70,7 @@ begin -- Initialize the simulator: Put_Line ("Initializing simulator with " & Strip (Num_Engines'Image) & " sequence engines, each with a stack depth of " & Strip (Stack_Depth'Image) & ". The starting command source ID is " & Strip (Start_Source_Id'Image) & "."); if not Simulator.Initialize (Sequence_Engine_Id (Num_Engines), Max_Seq_Num (Stack_Depth), Command_Source_Id (Start_Source_Id)) then - Put_Line ("An error occured initializing the engines!"); + Put_Line ("An error occurred initializing the engines!"); return; end if; diff --git a/src/components/command_sequencer/seq/simulator/seq_simulator.adb b/src/components/command_sequencer/seq/simulator/seq_simulator.adb index f8b02659..eeb0bba3 100644 --- a/src/components/command_sequencer/seq/simulator/seq_simulator.adb +++ b/src/components/command_sequencer/seq/simulator/seq_simulator.adb @@ -205,7 +205,7 @@ package body Seq_Simulator is end; when Error => Put_Line (ASCII.HT & "The runtime error code is: " & Trim (Self.Seq_Engines (To_Load).Get_Seq_Error_Code'Image, Ada.Strings.Left)); - Put_Line (ASCII.HT & "The error occured at pc: " & Trim (Self.Seq_Engines (To_Load).Get_Lowest_Child_Position'Image, Ada.Strings.Left)); + Put_Line (ASCII.HT & "The error occurred at pc: " & Trim (Self.Seq_Engines (To_Load).Get_Lowest_Child_Position'Image, Ada.Strings.Left)); New_Line; return; when Kill_Engines => diff --git a/src/components/command_sequencer/seq/test/seq_tests-implementation.adb b/src/components/command_sequencer/seq/test/seq_tests-implementation.adb index b50c84fa..08032969 100644 --- a/src/components/command_sequencer/seq/test/seq_tests-implementation.adb +++ b/src/components/command_sequencer/seq/test/seq_tests-implementation.adb @@ -161,7 +161,7 @@ package body Seq_Tests.Implementation is Seq_Error_Code_Assert.Eq (Engine.Get_Seq_Error_Code, Load_Length); Seq_Header.Length := Sequence.Length - 1; - -- Make sure loading to sequence not in unloaded state proces error. + -- Make sure loading to sequence not in unloaded state process error. Load_Status_Assert.Eq (Engine.Load (Sequence), Failure); Engine_State_Assert.Eq (Engine.Get_Engine_State, Engine_Error); State_Assert.Eq (Engine.Get_Running_Sequence_State, Error); @@ -1324,13 +1324,13 @@ package body Seq_Tests.Implementation is -- Valid jump position but no jump performed Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Fetch_Var (Self.Wb_Runner, Nonzerovarinstruction, Seq_Internal.A), 12); -- Loads a non-zero value into internal A Seq_Runtime.Tester.Set_Position (Self.Wb_Runner, 0); - Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Jump_If_Zero (Self.Wb_Runner, Header, Validjumpinstruction), 4); -- No jump should have occured + Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Jump_If_Zero (Self.Wb_Runner, Header, Validjumpinstruction), 4); -- No jump should have occurred State_Assert.Neq (Self.Wb_Runner.Get_State, Error); Seq_Runtime.Tester.Reset_Instance (Self.Wb_Runner); -- Valid jump position with jump performed Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Fetch_Var (Self.Wb_Runner, Zerovarinstruction, Seq_Internal.A), 12); -- Loads zero into internal A Seq_Runtime.Tester.Set_Position (Self.Wb_Runner, 0); - Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Jump_If_Zero (Self.Wb_Runner, Header, Validjumpinstruction), 85); -- A jump to 85 should have occured + Seq_Position_Assert.Eq (Seq_Runtime.Tester.Call_Jump_If_Zero (Self.Wb_Runner, Header, Validjumpinstruction), 85); -- A jump to 85 should have occurred State_Assert.Neq (Self.Wb_Runner.Get_State, Error); end Jump_If_Zero; diff --git a/src/components/command_sequencer/seq/types/seq_enums.enums.yaml b/src/components/command_sequencer/seq/types/seq_enums.enums.yaml index dad82a84..a3058908 100644 --- a/src/components/command_sequencer/seq/types/seq_enums.enums.yaml +++ b/src/components/command_sequencer/seq/types/seq_enums.enums.yaml @@ -7,7 +7,7 @@ enums: - name: NONE description: This means that the sequence is currently not in an error state. - name: PARSE - description: An instruction parse error occured. This can happen when an instruction has a constrained field (i.e. eval operations, fetch, store, etc.) and the read value does not conform to the constraint. + description: An instruction parse error occurred. This can happen when an instruction has a constrained field (i.e. eval operations, fetch, store, etc.) and the read value does not conform to the constraint. - name: OPCODE description: This occurs when an instruction opcode is read and it is not within the set of valid opcodes. Potential causes include misaligned memory, invalid jumps, compiler versions, bit corruption, etc. - name: COMMAND_PARSE @@ -31,7 +31,7 @@ enums: - name: LIMIT description: This occurs when a sequence has executed too many instructions in a row without blocking (instruction limit is mission configurable, and should be relatively high). - name: EVAL - description: An exception occured while performing an arithmetic, bitwise, or logical operation on two values. + description: An exception occurred while performing an arithmetic, bitwise, or logical operation on two values. - name: FLOAT_VALUE description: The runtime attempted to read an internal as a float, but the float was read as NaN/inf/-inf/some invalid value. - name: EXECUTE @@ -53,11 +53,11 @@ enums: - name: Recursion description: The sequence has exceeded its in-component recursion limit and is not executable. - name: Command_Timeout - description: A command response was not recieved within the timeout limit. + description: A command response was not received within the timeout limit. - name: Load_Timeout - description: A sequence load was not recieved within the timeout limit. + description: A sequence load was not received within the timeout limit. - name: Telemetry_Timeout - description: A telemetry value was not recieved within the timeout limit. + description: A telemetry value was not received within the timeout limit. - name: Unimplemented description: The opcode found has not been implemented in this runtime. - name: Seq_Operation @@ -146,7 +146,7 @@ enums: description: Requests that a sequence should be loaded on a different engine. - name: Start value: 5 - description: Requests that a sequence should be loaded on this engine, overwritting the current sequence. + description: Requests that a sequence should be loaded on this engine, overwriting the current sequence. - name: Push value: 6 description: Pushes arguments to the engine running the current sequence, will then be pushed to a newly loaded sequence. @@ -315,7 +315,7 @@ enums: - name: READY description: The sequence can safely be executed without any external work. This state happens after being awoken from sleeping, or after a successful load, etc. - name: DONE - description: The loaded sequence has successfully finished executing and will not execute until anoter sequence is loaded (or reloaded). + description: The loaded sequence has successfully finished executing and will not execute until another sequence is loaded (or reloaded). - name: WAIT_RELATIVE description: The sequence is waiting on a relative time value. - name: WAIT_ABSOLUTE @@ -397,7 +397,7 @@ enums: value: 85 description: Originally the char 'U'. Represents unsigned types. - name: Seq_Data_Format - description: This enums names the data formats used in Seq defining details about a telemetry item, including endianess. + description: This enums names the data formats used in Seq defining details about a telemetry item, including endianness. literals: - name: Unsigned_Byte value: 0 diff --git a/src/components/command_sequencer/seq/types/seq_types.ads b/src/components/command_sequencer/seq/types/seq_types.ads index af44b68b..ba9cb3c5 100644 --- a/src/components/command_sequencer/seq/types/seq_types.ads +++ b/src/components/command_sequencer/seq/types/seq_types.ads @@ -27,7 +27,7 @@ package Seq_Types is Num_Seq_Variables : constant Natural := 16; -- -- SEQ_NUM_GLOBAL_VARIABLES 48 - -- Adamant does not support global variables, so this is implicitley zero. + -- Adamant does not support global variables, so this is implicitly zero. -- -- SEQ_MAX_NESTED 3 -- Defined at command sequencer component initialization - Stack_Size. @@ -88,7 +88,7 @@ package Seq_Types is subtype Seq_String is Basic_Types.Byte_Array (0 .. Max_Seq_String_Size - 1); -- A 2D array of byte_arrays. Seq can handle 16 local variables. Every local variable is stored a byte_array of length 4, except for strings which are at max 64 bits in length. - -- Variable type is only determined when some sort of action on a varaible occurs. + -- Variable type is only determined when some sort of action on a variable occurs. type Seq_Local_Id is range 0 .. Num_Seq_Variables - 1; type Variable_Array is array (Seq_Local_Id) of Packed_Poly_32_Type.T; -- String pools not yet supported by Adamant implementation. diff --git a/src/components/command_sequencer/test/command_sequencer.tests.yaml b/src/components/command_sequencer/test/command_sequencer.tests.yaml index 401186f5..09588225 100644 --- a/src/components/command_sequencer/test/command_sequencer.tests.yaml +++ b/src/components/command_sequencer/test/command_sequencer.tests.yaml @@ -36,7 +36,7 @@ tests: - name: Test_Sequence_Timeouts description: This unit test tests sequence command and subsequence load timeouts. - name: Test_Issue_Details_Packet - description: This unit test tests issueing the details packet by command. + description: This unit test tests issuing the details packet by command. - name: Test_Set_Summary_Packet_Period description: This unit test tests changing the summary packet period by command. - name: Test_Command_Invalid_Engine diff --git a/src/components/command_sequencer/test/command_sequencer_tests-implementation.adb b/src/components/command_sequencer/test/command_sequencer_tests-implementation.adb index 681d67ac..95181a77 100644 --- a/src/components/command_sequencer/test/command_sequencer_tests-implementation.adb +++ b/src/components/command_sequencer/test/command_sequencer_tests-implementation.adb @@ -561,7 +561,7 @@ package body Command_Sequencer_Tests.Implementation is T.Command_Response_T_Send ((Source_Id => 1, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_2_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); - -- Now exepct the component to have output another command, the load sequence command: + -- Now expect the component to have output another command, the load sequence command: Natural_Assert.Eq (T.Event_T_Recv_Sync_History.Get_Count, 1); Natural_Assert.Eq (T.Command_T_Recv_Sync_History.Get_Count, 2); Load_Command := Create_Sequence_Load_Command (Id => 8, Engine_Number => 1, Engine_Request => Specific_Engine); @@ -1069,7 +1069,7 @@ package body Command_Sequencer_Tests.Implementation is T.Component_B_Data_Product_2 := (Value => 9.9); T.Component_B_Data_Product_1 := (Value => 22); - -- OK now send the command response to allow the sequnce to continue executing. + -- OK now send the command response to allow the sequence to continue executing. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_3_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -1081,7 +1081,7 @@ package body Command_Sequencer_Tests.Implementation is T.Component_A_Data_Product_1 := (Value => 2); T.Component_B_Data_Product_2 := (Value => 8.76); - -- OK now send the command response to allow the sequnce to continue executing. + -- OK now send the command response to allow the sequence to continue executing. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_3_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -1089,7 +1089,7 @@ package body Command_Sequencer_Tests.Implementation is Natural_Assert.Eq (T.Command_T_Recv_Sync_History.Get_Count, 3); Command_Assert.Eq (T.Command_T_Recv_Sync_History.Get (3), Component_A_Commands.Command_3 ((Value => 99))); - -- OK now send the command response to allow the sequnce to continue executing. + -- OK now send the command response to allow the sequence to continue executing. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_3_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -1097,7 +1097,7 @@ package body Command_Sequencer_Tests.Implementation is Natural_Assert.Eq (T.Command_T_Recv_Sync_History.Get_Count, 4); Command_Assert.Eq (T.Command_T_Recv_Sync_History.Get (4), Component_A_Commands.Command_3 ((Value => 99))); - -- OK now send the command response to allow the sequnce to continue executing. + -- OK now send the command response to allow the sequence to continue executing. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_3_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -1134,7 +1134,7 @@ package body Command_Sequencer_Tests.Implementation is Natural_Assert.Eq (T.Command_T_Recv_Sync_History.Get_Count, 5); Command_Assert.Eq (T.Command_T_Recv_Sync_History.Get (5), Component_A_Commands.Command_3 ((Value => 99))); - -- OK now send the command response to allow the sequnce to continue executing. + -- OK now send the command response to allow the sequence to continue executing. T.Command_Response_T_Send ((Source_Id => 0, Registration_Id => 0, Command_Id => Component_A_Commands.Get_Command_3_Id, Status => Success)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -1310,7 +1310,7 @@ package body Command_Sequencer_Tests.Implementation is Natural_Assert.Eq (T.Dispatch_All, 1); Natural_Assert.Eq (T.Event_T_Recv_Sync_History.Get_Count, 1); - -- Ok n ext telemetry comparion = Passes + -- Ok n ext telemetry comparison = Passes T.Component_B_Data_Product_1 := (Value => 1); T.Tick_T_Send (((0, 0), 0)); Natural_Assert.Eq (T.Dispatch_All, 1); @@ -3345,7 +3345,7 @@ package body Command_Sequencer_Tests.Implementation is -- Test killing invalid engine: --------------------------------------------- - -- OK now send the kill command to kill non existant engine: + -- OK now send the kill command to kill non existent engine: T.Command_T_Send (T.Commands.Kill_Engine ((Engine_Id => 3))); Natural_Assert.Eq (T.Dispatch_All, 1); Natural_Assert.Eq (T.Command_Response_T_Recv_Sync_History.Get_Count, 2); diff --git a/src/components/command_sequencer/test/command_sequencer_tests-implementation.ads b/src/components/command_sequencer/test/command_sequencer_tests-implementation.ads index 71b83836..de59175f 100644 --- a/src/components/command_sequencer/test/command_sequencer_tests-implementation.ads +++ b/src/components/command_sequencer/test/command_sequencer_tests-implementation.ads @@ -46,7 +46,7 @@ private overriding procedure Test_Sequence_Execution_Error (Self : in out Instance); -- This unit test tests sequence command and subsequence load timeouts. overriding procedure Test_Sequence_Timeouts (Self : in out Instance); - -- This unit test tests issueing the details packet by command. + -- This unit test tests issuing the details packet by command. overriding procedure Test_Issue_Details_Packet (Self : in out Instance); -- This unit test tests changing the summary packet period by command. overriding procedure Test_Set_Summary_Packet_Period (Self : in out Instance); diff --git a/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.adb b/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.adb index ad1970ab..c83845ff 100644 --- a/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.adb +++ b/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.adb @@ -430,7 +430,7 @@ package body Component.Command_Sequencer.Implementation.Tester is Self.Killed_All_Engines_History.Push (Arg); end Killed_All_Engines; - -- A command was executed to kill a sequence running in a specic engine + -- A command was executed to kill a sequence running in a specific engine overriding procedure Killed_Engine (Self : in out Instance; Arg : in Packed_Sequence_Engine_Id.T) is begin -- Push the argument onto the test history for looking at later: @@ -486,7 +486,7 @@ package body Component.Command_Sequencer.Implementation.Tester is Self.Unexpected_Register_Source_History.Push (Arg); end Unexpected_Register_Source; - -- An error occured while executing a sequence. + -- An error occurred while executing a sequence. overriding procedure Sequence_Execution_Error (Self : in out Instance; Arg : in Engine_Error_Type.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.ads b/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.ads index 0d8303a9..e64bc815 100644 --- a/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.ads +++ b/src/components/command_sequencer/test/component-command_sequencer-implementation-tester.ads @@ -43,7 +43,7 @@ with Seq_Print_Event_Record.Representation; -- The Command Sequencer component executes command sequences with a configurable number of engines. The sequence engines execute sequences in the LASP Awesome Sequence Engine Language (LASEL) compiled by the LASP SEQ tool. Documentation on LASEL is included in this component's doc/ directory. -- --- This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precendence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceding. +-- This component runs a configurable number of sequence engines using a single Adamant task. The task runs each engine in priority order, where lower numbered engines take precedence over higher numbered engines. Each engine contains a configurable-sized stack that allows sequences to call subsequences. This component adheres to the property that commands are only executed after previous commands have completed (ie. a command response has been received). In this way the sequences are largely event driven, waiting on the execution of previous commands to finish prior to executing subsequent ones. A periodic tick is supplied to the component to provide timing control for sequences that need to execute relative or absolute waits, or check until a telemetry condition has been met before proceeding. -- -- The sequence engine and LASEL interpreter is located in the seq/ directory. package Component.Command_Sequencer.Implementation.Tester is @@ -269,7 +269,7 @@ package Component.Command_Sequencer.Implementation.Tester is overriding procedure Sequence_Load_Error (Self : in out Instance; Arg : in Sequence_Load_Error_Info.T); -- A command was executed to kill all running sequences. overriding procedure Killed_All_Engines (Self : in out Instance); - -- A command was executed to kill a sequence running in a specic engine + -- A command was executed to kill a sequence running in a specific engine overriding procedure Killed_Engine (Self : in out Instance; Arg : in Packed_Sequence_Engine_Id.T); -- A command was dropped due to a full queue. overriding procedure Dropped_Command (Self : in out Instance; Arg : in Command_Header.T); @@ -285,7 +285,7 @@ package Component.Command_Sequencer.Implementation.Tester is overriding procedure Unexpected_Command_Response (Self : in out Instance; Arg : in Command_Response.T); -- An extra source registration was received, but all engines have a source ID already. overriding procedure Unexpected_Register_Source (Self : in out Instance; Arg : in Command_Response.T); - -- An error occured while executing a sequence. + -- An error occurred while executing a sequence. overriding procedure Sequence_Execution_Error (Self : in out Instance; Arg : in Engine_Error_Type.T); -- A sequence timed out waiting on a command response of subsequence load. overriding procedure Sequence_Timeout_Error (Self : in out Instance; Arg : in Engine_Error_Type.T); diff --git a/src/components/command_sequencer/test/test_component/test_component.component.yaml b/src/components/command_sequencer/test/test_component/test_component.component.yaml index 863e1d7b..ac08e2f7 100644 --- a/src/components/command_sequencer/test/test_component/test_component.component.yaml +++ b/src/components/command_sequencer/test/test_component/test_component.component.yaml @@ -2,7 +2,7 @@ description: A simple component which receives commands to help simulate an assembly that has commandable components. execution: passive connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to send command responses. diff --git a/src/components/command_sequencer/test/test_sequences/recurs_subseq_18.txt b/src/components/command_sequencer/test/test_sequences/recurs_subseq_18.txt index 002ec073..14993d8f 100644 --- a/src/components/command_sequencer/test/test_sequences/recurs_subseq_18.txt +++ b/src/components/command_sequencer/test/test_sequences/recurs_subseq_18.txt @@ -1,4 +1,4 @@ seq recurs_subseq_18 - ; Call this function again. This will eventuall fill and overflow the sequence engine stack. + ; Call this function again. This will eventually fill and overflow the sequence engine stack. call recurs_subseq_18 endseq diff --git a/src/components/connector_counter_16/component-connector_counter_16-implementation.ads b/src/components/connector_counter_16/component-connector_counter_16-implementation.ads index aa31c8de..186f1ee3 100644 --- a/src/components/connector_counter_16/component-connector_counter_16-implementation.ads +++ b/src/components/connector_counter_16/component-connector_counter_16-implementation.ads @@ -6,7 +6,7 @@ with Command; with Protected_Variables; --- This generic component attaches to a connector and counts the invocations occuring on that connector. It then reports this count as a data product and passes the connector invocation through to a connected component on the other side. The count rolls over at 255 and is 1 byte wide. +-- This generic component attaches to a connector and counts the invocations occurring on that connector. It then reports this count as a data product and passes the connector invocation through to a connected component on the other side. The count rolls over at 255 and is 1 byte wide. generic package Component.Connector_Counter_16.Implementation is diff --git a/src/components/connector_counter_8/component-connector_counter_8-implementation.ads b/src/components/connector_counter_8/component-connector_counter_8-implementation.ads index 9969c896..897eb274 100644 --- a/src/components/connector_counter_8/component-connector_counter_8-implementation.ads +++ b/src/components/connector_counter_8/component-connector_counter_8-implementation.ads @@ -6,7 +6,7 @@ with Command; with Protected_Variables; --- This generic component attaches to a connector and counts the invocations occuring on that connector. It then reports this count as a data product and passes the connector invocation through to a connected component on the other side. The count rolls over at 255 and is 1 byte wide. +-- This generic component attaches to a connector and counts the invocations occurring on that connector. It then reports this count as a data product and passes the connector invocation through to a connected component on the other side. The count rolls over at 255 and is 1 byte wide. generic package Component.Connector_Counter_8.Implementation is diff --git a/src/components/connector_protector/component-connector_protector-implementation.ads b/src/components/connector_protector/component-connector_protector-implementation.ads index 92608ac9..cb0a191c 100644 --- a/src/components/connector_protector/component-connector_protector-implementation.ads +++ b/src/components/connector_protector/component-connector_protector-implementation.ads @@ -2,7 +2,7 @@ -- Connector_Protector Component Implementation Spec -------------------------------------------------------------------------------- --- This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is automic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. +-- This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is atomic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. generic package Component.Connector_Protector.Implementation is diff --git a/src/components/connector_protector/connector_protector.component.yaml b/src/components/connector_protector/connector_protector.component.yaml index 996c6c2a..a51293ae 100644 --- a/src/components/connector_protector/connector_protector.component.yaml +++ b/src/components/connector_protector/connector_protector.component.yaml @@ -1,5 +1,5 @@ --- -description: This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is automic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. +description: This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is atomic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. execution: passive generic: description: The is generic component in that it can be instantiated to protect a connector of any type at compile time. diff --git a/src/components/connector_protector/test/component-connector_protector-implementation-tester.ads b/src/components/connector_protector/test/component-connector_protector-implementation-tester.ads index 7f1f7f24..e2fcbf8b 100644 --- a/src/components/connector_protector/test/component-connector_protector-implementation-tester.ads +++ b/src/components/connector_protector/test/component-connector_protector-implementation-tester.ads @@ -6,7 +6,7 @@ with Component.Connector_Protector_Reciprocal; with History; --- This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is automic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. +-- This is a generic component that can be used to protect (as in protected object) the call to the input connector. The component serves as a multi-tasking safe synchronization point for multiple callers. When the T_Recv_Sync connector is called, the component immediately calls the T_Send connector, passing through any arguments. The T_Send connector is called from within a protected object, and so its execution is atomic with respect to other callers of T_Recv_Sync. That is, the call to T_Send will finish before another task is allowed to invoke T_Recv_Sync (and thus T_Send). The protection mechanism effectively makes all downstream connector calls of this component thread-safe. The advantage of this component is that deploying it appropriately in an assembly can provide thread-safety to components which are not designed to be thread-safe in and of themselves. generic package Component.Connector_Protector.Implementation.Tester is diff --git a/src/components/cpu_monitor/component-cpu_monitor-implementation.adb b/src/components/cpu_monitor/component-cpu_monitor-implementation.adb index 55d7313b..2b022728 100644 --- a/src/components/cpu_monitor/component-cpu_monitor-implementation.adb +++ b/src/components/cpu_monitor/component-cpu_monitor-implementation.adb @@ -100,7 +100,7 @@ package body Component.Cpu_Monitor.Implementation is end if; exception -- Handle divide by zero error, which may happen on start up. - -- A constaint error could occur too if the times are wonky. + -- A constraint error could occur too if the times are wonky. when others => return 0; end Cpu_Percentage; @@ -180,7 +180,7 @@ package body Component.Cpu_Monitor.Implementation is Self.Count := (Self.Count + 1) mod Self.Max_Count; end Tick_T_Recv_Sync; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/cpu_monitor/component-cpu_monitor-implementation.ads b/src/components/cpu_monitor/component-cpu_monitor-implementation.ads index 0259adf4..4d384d32 100644 --- a/src/components/cpu_monitor/component-cpu_monitor-implementation.ads +++ b/src/components/cpu_monitor/component-cpu_monitor-implementation.ads @@ -76,7 +76,7 @@ private --------------------------------------- -- This is the base tick for the component. overriding procedure Tick_T_Recv_Sync (Self : in out Instance; Arg : in Tick.T); - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T); --------------------------------------- diff --git a/src/components/cpu_monitor/cpu_monitor.component.yaml b/src/components/cpu_monitor/cpu_monitor.component.yaml index 37f6d7d1..53c1d915 100644 --- a/src/components/cpu_monitor/cpu_monitor.component.yaml +++ b/src/components/cpu_monitor/cpu_monitor.component.yaml @@ -36,7 +36,7 @@ connectors: - description: The system time is retrieved via this connector. return_type: Sys_Time.T kind: get - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/cpu_monitor/test/cpu_monitor.tests.yaml b/src/components/cpu_monitor/test/cpu_monitor.tests.yaml index 13c842e4..6b1ee6b2 100644 --- a/src/components/cpu_monitor/test/cpu_monitor.tests.yaml +++ b/src/components/cpu_monitor/test/cpu_monitor.tests.yaml @@ -2,6 +2,6 @@ description: This is a unit test suite for the CPU Monitor component. Testing the actual correctness of the produced CPU monitor packet is not easy to do at the unit test level. This will be done at an integrated test level. The unit tests below make sure commanding and packet generation of the component works as expected. tests: - name: Test_Packet_Period - description: This unit test excersizes the command to change the packet creation rate. + description: This unit test exercises the command to change the packet creation rate. - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. diff --git a/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.adb b/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.adb index 1d62ba4a..0030a97d 100644 --- a/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.adb +++ b/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.adb @@ -23,12 +23,12 @@ package body Cpu_Monitor_Tests.Implementation is --- Task definitions: Task_Info_1 : aliased Task_Types.Task_Info := (Number => 1, Id => Ada.Task_Identification.Null_Task_Id, - -- The following is initialized by the component iself. + -- The following is initialized by the component itself. Priority => 0, Stack_Address => System.Null_Address, Stack_Size => 0, Secondary_Stack_Address => System.Null_Address, Secondary_Stack_Size => 0, Secondary_Stack_Max_Usage => 0); Task_Info_2 : aliased Task_Types.Task_Info := (Number => 2, Id => Ada.Task_Identification.Current_Task, - -- The following is initialized by the component iself. + -- The following is initialized by the component itself. Priority => 0, Stack_Address => System.Null_Address, Stack_Size => 0, Secondary_Stack_Address => System.Null_Address, Secondary_Stack_Size => 0, Secondary_Stack_Max_Usage => 0); -- List of task infos for all tasks: diff --git a/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.ads b/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.ads index e688e578..907f9811 100644 --- a/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.ads +++ b/src/components/cpu_monitor/test/cpu_monitor_tests-implementation.ads @@ -11,7 +11,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the command to change the packet creation rate. + -- This unit test exercises the command to change the packet creation rate. overriding procedure Test_Packet_Period (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); diff --git a/src/components/event_filter/component-event_filter-implementation.adb b/src/components/event_filter/component-event_filter-implementation.adb index ba6a491a..1c8914ec 100644 --- a/src/components/event_filter/component-event_filter-implementation.adb +++ b/src/components/event_filter/component-event_filter-implementation.adb @@ -94,7 +94,7 @@ package body Component.Event_Filter.Implementation is pragma Assert (Event_Id_Start_Range <= Event_Id_End_Range, "End id must be equal to or greater than the start ID for the event filter"); Self.Event_Entries.Init (Event_Id_Start_Range, Event_Id_End_Range, Event_Filter_List); - -- Grab the array length of the entries to make sure that the length isnt longer than the max size of a packet + -- Grab the array length of the entries to make sure that the length isn't longer than the max size of a packet Event_Entry_Array := Self.Event_Entries.Get_Entry_Array; -- Make sure our size is not larger than the size of a packet pragma Assert (Event_Entry_Array'Length <= Packet_Types.Packet_Buffer_Length_Type'Last, "Packet length for the event states in event filter is larger than the max packet length"); diff --git a/src/components/event_filter/event_filter.component.yaml b/src/components/event_filter/event_filter.component.yaml index 748cc285..7666d246 100644 --- a/src/components/event_filter/event_filter.component.yaml +++ b/src/components/event_filter/event_filter.component.yaml @@ -34,7 +34,7 @@ connectors: type: Event.T kind: send name: Event_Forward_T_Send - - description: The Event connector to send the events specifc to the component. + - description: The Event connector to send the events specific to the component. type: Event.T kind: send - description: The system time is retrieved via this connector. diff --git a/src/components/event_filter/event_filter.requirements.yaml b/src/components/event_filter/event_filter.requirements.yaml index e3455cb2..4c03606e 100644 --- a/src/components/event_filter/event_filter.requirements.yaml +++ b/src/components/event_filter/event_filter.requirements.yaml @@ -1,7 +1,7 @@ --- description: These are the requirements for the Event Filter component. requirements: - - text: The Event Filter component shall accept all events and pass then on if not filtered or out of the begining set range of IDs. + - text: The Event Filter component shall accept all events and pass then on if not filtered or out of the beginning set range of IDs. - text: The Event Filter component shall track the number of events that are filtered. - text: The Event Filter component shall not filter events if they are set to unfiltered. - text: The Event Filter component shall have the ability to filter or unfilter events by command. diff --git a/src/components/event_filter/event_filter_entry/event_filter_entry.adb b/src/components/event_filter/event_filter_entry/event_filter_entry.adb index 9de48cbd..9dc67b0b 100644 --- a/src/components/event_filter/event_filter_entry/event_filter_entry.adb +++ b/src/components/event_filter/event_filter_entry/event_filter_entry.adb @@ -28,7 +28,7 @@ package body Event_Filter_Entry is State_7 => Event_Filter_State.Unfiltered )) (0)); - -- Then disable the event baised on our disable list + -- Then disable the event based on our disable list for Event_Id_To_Filter of Event_Filter_List loop Status := Set_Filter_State (Self, Event_Id_To_Filter, Event_Filter_State.Filtered); -- Assert here on status diff --git a/src/components/event_filter/event_filter_entry/test/event_filter_entry.tests.yaml b/src/components/event_filter/event_filter_entry/test/event_filter_entry.tests.yaml index 29cdc5fe..3a2ca029 100644 --- a/src/components/event_filter/event_filter_entry/test/event_filter_entry.tests.yaml +++ b/src/components/event_filter/event_filter_entry/test/event_filter_entry.tests.yaml @@ -2,7 +2,7 @@ description: This is a unit test suite forthe two_counter_entry object for help with the event_limiter tests: - name: Test_Init_List - description: This test is inteded to test the different permutations of the init of the byte array. + description: This test is intended to test the different permutations of the init of the byte array. - name: Test_Set_Event_State description: This unit test tests changing the event state to a desired value for a given ID. - name: Test_Event_Filtered_Count diff --git a/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.adb b/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.adb index 90fa1579..a066bda3 100644 --- a/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.adb +++ b/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.adb @@ -201,7 +201,7 @@ package body Event_Filter_Entry_Tests.Implementation is State_Return_Status := Event_Filter.Filter_Event (1); Event_Filter_Status_Assert.Eq (State_Return_Status, Unfiltered); - -- Since there is only one, test the boundry cases + -- Since there is only one, test the boundary cases State_Return_Status := Event_Filter.Filter_Event (0); Event_Filter_Status_Assert.Eq (State_Return_Status, Out_Of_Range); @@ -240,7 +240,7 @@ package body Event_Filter_Entry_Tests.Implementation is State_Filter_Status := Event_Filter.Filter_Event (0); Event_Filter_Status_Assert.Eq (State_Filter_Status, Unfiltered); - -- Same process as before but refersed on one that begins filterd + -- Same process as before but refersed on one that begins filtered State_Filter_Status := Event_Filter.Filter_Event (3); Event_Filter_Status_Assert.Eq (State_Filter_Status, Filtered); diff --git a/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.ads b/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.ads index cd72a92b..c3006ee1 100644 --- a/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.ads +++ b/src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.ads @@ -12,7 +12,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This test is inteded to test the different permutations of the init of the byte array. + -- This test is intended to test the different permutations of the init of the byte array. overriding procedure Test_Init_List (Self : in out Instance); -- This unit test tests changing the event state to a desired value for a given ID. overriding procedure Test_Set_Event_State (Self : in out Instance); diff --git a/src/components/event_filter/test/component-event_filter-implementation-tester.adb b/src/components/event_filter/test/component-event_filter-implementation-tester.adb index 9dfce5fc..50f0d144 100644 --- a/src/components/event_filter/test/component-event_filter-implementation-tester.adb +++ b/src/components/event_filter/test/component-event_filter-implementation-tester.adb @@ -97,7 +97,7 @@ package body Component.Event_Filter.Implementation.Tester is Self.Dispatch_Event (Arg); end Event_Forward_T_Recv_Sync; - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/event_filter/test/component-event_filter-implementation-tester.ads b/src/components/event_filter/test/component-event_filter-implementation-tester.ads index 91773c1f..f99e1899 100644 --- a/src/components/event_filter/test/component-event_filter-implementation-tester.ads +++ b/src/components/event_filter/test/component-event_filter-implementation-tester.ads @@ -102,7 +102,7 @@ package Component.Event_Filter.Implementation.Tester is --------------------------------------- -- The Event connector to forward on events when the filtering is disabled, or if unknown events come in. overriding procedure Event_Forward_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); -- The system time is retrieved via this connector. overriding function Sys_Time_T_Return (Self : in out Instance) return Sys_Time.T; diff --git a/src/components/event_filter/types/event_component_state_type.record.yaml b/src/components/event_filter/types/event_component_state_type.record.yaml index 11cd994e..576f4f5d 100644 --- a/src/components/event_filter/types/event_component_state_type.record.yaml +++ b/src/components/event_filter/types/event_component_state_type.record.yaml @@ -2,6 +2,6 @@ description: This record is for the data product that indicates if the event filter component is enabled for filtering or disabled all together. fields: - name: Component_Filter_State - description: Flag to indicate if the component is enabled or disabled at a overriding level from the individal event states + description: Flag to indicate if the component is enabled or disabled at a overriding level from the individual event states type: Event_Filter_Entry_Enums.Global_Filter_State.E format: E8 diff --git a/src/components/event_limiter/component-event_limiter-implementation.adb b/src/components/event_limiter/component-event_limiter-implementation.adb index 0af02b0e..a067dc24 100644 --- a/src/components/event_limiter/component-event_limiter-implementation.adb +++ b/src/components/event_limiter/component-event_limiter-implementation.adb @@ -102,7 +102,7 @@ package body Component.Event_Limiter.Implementation is -- event_Id_Start : Event_Types.Event_Id - The number of packets that the component contains internally. This is the available buffer that the component has to store events. When all packets are exhausted, then the component begins dropping events. The component needs to be at least double buffered, meaning a minimum of two packets need to be allocated. -- event_Id_Stop : Event_Types.Event_Id - The number of ticks that can be received before a partial packet timeout occurs. When a partial packet timeout occurs, a packet containing at least one event is sent out, and then the timeout is reset. A value of zero passed for this parameter will disable the partial packet timeout, meaning only full packets are ever sent out of the component. -- event_Disable_List : Two_Counter_Entry.Event_Id_List - A list of event IDs that are enabled by default - -- event_Limit_Persistence : Two_Counter_Entry.Persistence_Type - The inital persistence of the number of events to allow before limiting them between ticks (1 to 7) + -- event_Limit_Persistence : Two_Counter_Entry.Persistence_Type - The initial persistence of the number of events to allow before limiting them between ticks (1 to 7) -- overriding procedure Init (Self : in out Instance; Event_Id_Start : in Event_Types.Event_Id; Event_Id_Stop : in Event_Types.Event_Id; Event_Disable_List : in Two_Counter_Entry.Event_Id_List := (1 .. 0 => 0); Event_Limit_Persistence : in Two_Counter_Entry.Persistence_Type) @@ -112,7 +112,7 @@ package body Component.Event_Limiter.Implementation is -- This is asserted in the package as well but added here for extra clarity pragma Assert (Event_Id_Stop >= Event_Id_Start, "Stop id must be equal to or greater than the start ID for the event limiter"); - -- Divide by 8 to determine the number of ids we need to accomodate (1 id per bit). Add eight since the difference needs to account for an extra byte if we have ids that need to fil up some of the next byte + -- Divide by 8 to determine the number of ids we need to accommodate (1 id per bit). Add eight since the difference needs to account for an extra byte if we have ids that need to fil up some of the next byte Self.State_Packet_Size := Natural (Event_Id_Stop - Event_Id_Start + 8) / 8; -- Make sure our size is not larger than the size of a packet pragma Assert (Self.State_Packet_Size <= Packet_Types.Packet_Buffer_Length_Type'Last, "Packet length for the event states in event limiter is larger than the max packet length"); @@ -147,13 +147,13 @@ package body Component.Event_Limiter.Implementation is case Status is when Success => null; -- do nothing here and move on - -- Save the event id into our event that indicates this id was limited (if room is avaliable) + -- Save the event id into our event that indicates this id was limited (if room is available) when Event_Max_Limit => if Num_Event_Limited_Event.Num_Event_Ids <= Num_Event_Limited_Event.Event_Id_Limited_Array'Length then Num_Event_Limited_Event.Event_Id_Limited_Array (Integer (Num_Event_Limited_Event.Num_Event_Ids)) := Dec_Event_Id; Num_Event_Limited_Event.Num_Event_Ids := Num_Event_Limited_Event.Num_Event_Ids + 1; end if; - -- Assert on the status. We know the range so we shouldnt get an invalid_Id error + -- Assert on the status. We know the range so we shouldn't get an invalid_Id error when Invalid_Id => pragma Assert (False, "Invalid_Id found when decrementing all event limiter counters which should not be possible: " & Natural'Image (Natural (Dec_Event_Id))); end case; @@ -183,7 +183,7 @@ package body Component.Event_Limiter.Implementation is Bit_Location := Bit_Num ((Id - Id_Start) mod 8); case Bit_Location is when 0 => - -- Reset the bitmap incase this is the last byte but isnt fully filled + -- Reset the bitmap in case this is the last byte but isn't fully filled Event_Bitmap := (State_0 => Disabled, State_1 => Disabled, State_2 => Disabled, State_3 => Disabled, State_4 => Disabled, State_5 => Disabled, State_6 => Disabled, State_7 => Disabled); Event_Bitmap.State_0 := Event_State; when 1 => @@ -243,7 +243,7 @@ package body Component.Event_Limiter.Implementation is overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T) is Status : Two_Counter_Entry.Count_Status; begin - -- Regardless of the global state, we call the increment. The global component enable/disable state as well as each individual id state is handled in the increment for efficency. + -- Regardless of the global state, we call the increment. The global component enable/disable state as well as each individual id state is handled in the increment for efficiency. Self.Event_Array.Increment_Counter (Arg.Header.Id, Status); -- Only when status is an Event_Max_Limit, then we dont do anything. Otherwise, the event gets passed on case Status is diff --git a/src/components/event_limiter/component-event_limiter-implementation.ads b/src/components/event_limiter/component-event_limiter-implementation.ads index fcc13706..75a1425d 100644 --- a/src/components/event_limiter/component-event_limiter-implementation.ads +++ b/src/components/event_limiter/component-event_limiter-implementation.ads @@ -24,7 +24,7 @@ package Component.Event_Limiter.Implementation is -- event_Id_Start : Event_Types.Event_Id - The number of packets that the component contains internally. This is the available buffer that the component has to store events. When all packets are exhausted, then the component begins dropping events. The component needs to be at least double buffered, meaning a minimum of two packets need to be allocated. -- event_Id_Stop : Event_Types.Event_Id - The number of ticks that can be received before a partial packet timeout occurs. When a partial packet timeout occurs, a packet containing at least one event is sent out, and then the timeout is reset. A value of zero passed for this parameter will disable the partial packet timeout, meaning only full packets are ever sent out of the component. -- event_Disable_List : Two_Counter_Entry.Event_Id_List - A list of event IDs that are enabled by default - -- event_Limit_Persistence : Two_Counter_Entry.Persistence_Type - The inital persistence of the number of events to allow before limiting them between ticks (1 to 7) + -- event_Limit_Persistence : Two_Counter_Entry.Persistence_Type - The initial persistence of the number of events to allow before limiting them between ticks (1 to 7) -- overriding procedure Init (Self : in out Instance; Event_Id_Start : in Event_Types.Event_Id; Event_Id_Stop : in Event_Types.Event_Id; Event_Disable_List : in Two_Counter_Entry.Event_Id_List := (1 .. 0 => 0); Event_Limit_Persistence : in Two_Counter_Entry.Persistence_Type); diff --git a/src/components/event_limiter/event_limiter.component.yaml b/src/components/event_limiter/event_limiter.component.yaml index cfb1815f..eaf858e9 100644 --- a/src/components/event_limiter/event_limiter.component.yaml +++ b/src/components/event_limiter/event_limiter.component.yaml @@ -25,7 +25,7 @@ init: default: "(1 .. 0 => 0)" - name: Event_Limit_Persistence type: Two_Counter_Entry.Persistence_Type - description: The inital persistence of the number of events to allow before limiting them between ticks (1 to 7) + description: The initial persistence of the number of events to allow before limiting them between ticks (1 to 7) connectors: - description: This is the base tick for the component. Upon reception the component will decrement the count of each ID unless it is already 0. Every tick, an event of what has been filtered will be sent. type: Tick.T @@ -40,7 +40,7 @@ connectors: type: Event.T kind: send name: Event_Forward_T_Send - - description: The Event connector to send the events specifc to the component. + - description: The Event connector to send the events specific to the component. type: Event.T kind: send - description: The system time is retrieved via this connector. diff --git a/src/components/event_limiter/test/component-event_limiter-implementation-tester.adb b/src/components/event_limiter/test/component-event_limiter-implementation-tester.adb index 330f27d0..5e415410 100644 --- a/src/components/event_limiter/test/component-event_limiter-implementation-tester.adb +++ b/src/components/event_limiter/test/component-event_limiter-implementation-tester.adb @@ -94,7 +94,7 @@ package body Component.Event_Limiter.Implementation.Tester is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_Forward_T_Recv_Sync (Self : in out Instance; Arg : in Event.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/event_limiter/test/component-event_limiter-implementation-tester.ads b/src/components/event_limiter/test/component-event_limiter-implementation-tester.ads index f3ee7c69..431a1e8c 100644 --- a/src/components/event_limiter/test/component-event_limiter-implementation-tester.ads +++ b/src/components/event_limiter/test/component-event_limiter-implementation-tester.ads @@ -113,7 +113,7 @@ package Component.Event_Limiter.Implementation.Tester is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- The Event connector to send the events specifc to the component. + -- The Event connector to send the events specific to the component. overriding procedure Event_Forward_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); -- The Event connector to forward on events if enabled and not limited overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); diff --git a/src/components/event_limiter/test/event_limiter.tests.yaml b/src/components/event_limiter/test/event_limiter.tests.yaml index b8198949..80a155ff 100644 --- a/src/components/event_limiter/test/event_limiter.tests.yaml +++ b/src/components/event_limiter/test/event_limiter.tests.yaml @@ -4,7 +4,7 @@ tests: - name: Test_Received_Event description: This unit test is to test incrementing counters for the range events as they come in with both enabled and disabled states. - name: Test_Decrement_Event_Count - description: This unit test is to test the decrement of all the event counters in the tick and the contruction of the event if events were limited. + description: This unit test is to test the decrement of all the event counters in the tick and the construction of the event if events were limited. - name: Test_Issue_State_Packet description: This unit test sends the issue command and test that the appropriate values are received in that packet. - name: Test_Command_Single_State_Change diff --git a/src/components/event_limiter/test/event_limiter_tests-implementation.adb b/src/components/event_limiter/test/event_limiter_tests-implementation.adb index 62d33664..1e3bf09d 100644 --- a/src/components/event_limiter/test/event_limiter_tests-implementation.adb +++ b/src/components/event_limiter/test/event_limiter_tests-implementation.adb @@ -252,7 +252,7 @@ package body Event_Limiter_Tests.Implementation is T.Event_T_Send (Incoming_Event); Natural_Assert.Eq (T.Event_Forward_T_Recv_Sync_History.Get_Count, 6); - -- Again check the data product before we would issue another but the next one shouldnt have any limited messages + -- Again check the data product before we would issue another but the next one shouldn't have any limited messages Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 4); -- Now decrement once to get the data product and make sure we tracked the number of limited events @@ -289,7 +289,7 @@ package body Event_Limiter_Tests.Implementation is Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 0); Natural_Assert.Eq (T.Event_Forward_T_Recv_Sync_History.Get_Count, 0); - -- Perfom a tick before anything is sent which helps make sure that decrementing on a 0 count doent produce anything + -- Perform a tick before anything is sent which helps make sure that decrementing on a 0 count doent produce anything T.Tick_T_Send (Input_Tick); Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 1); Packed_U16_Assert.Eq (T.Limited_Events_Since_Tick_History.Get (1), (Value => 0)); @@ -471,7 +471,7 @@ package body Event_Limiter_Tests.Implementation is Put_Line ("----------------------------------"); Put_Line ("Testing Issue State Packet:"); Put_Line ("----------------------------------"); - -- Setup some events that are enabled and some disabled with a small persistance to quickly test if the state change was successfull. + -- Setup some events that are enabled and some disabled with a small persistence to quickly test if the state change was successful. Self.Tester.Component_Instance.Init (Event_Id_Start => Start_Id, Event_Id_Stop => 13, Event_Disable_List => Event_Start_List, Event_Limit_Persistence => 5); -- Just send the packet and check that everything is as expected. There are a mix of enabled and disabled that should be confirmed. @@ -530,7 +530,7 @@ package body Event_Limiter_Tests.Implementation is Put_Line ("----------------------------------"); Put_Line ("Testing Change Single Event State:"); Put_Line ("----------------------------------"); - -- Setup some events that are enabled and some disabled with a small persistance to quickly test if the state change was successfull. + -- Setup some events that are enabled and some disabled with a small persistence to quickly test if the state change was successful. Self.Tester.Component_Instance.Init (Event_Id_Start => Start_Id, Event_Id_Stop => 10, Event_Disable_List => Event_Start_List, Event_Limit_Persistence => 2); -- Start by disabling an enabled event. @@ -644,7 +644,7 @@ package body Event_Limiter_Tests.Implementation is Put_Line ("----------------------------------"); Put_Line ("Testing Change Range Event State:"); Put_Line ("----------------------------------"); - -- Setup some events that are enabled and some disabled with a small persistance to quickly test if the state change was successfull. + -- Setup some events that are enabled and some disabled with a small persistence to quickly test if the state change was successful. Self.Tester.Component_Instance.Init (Event_Id_Start => Start_Id, Event_Id_Stop => 10, Event_Disable_List => Event_Start_List, Event_Limit_Persistence => 2); -- Start by enabling all events. @@ -781,7 +781,7 @@ package body Event_Limiter_Tests.Implementation is Put_Line ("----------------------------------"); Put_Line ("Testing Change All Event States:"); Put_Line ("----------------------------------"); - -- Setup some events that are enabled and some disabled with a small persistance to quickly test if the state change was successfull. + -- Setup some events that are enabled and some disabled with a small persistence to quickly test if the state change was successful. Self.Tester.Component_Instance.Init (Event_Id_Start => Start_Id, Event_Id_Stop => 11, Event_Disable_List => Event_Start_List, Event_Limit_Persistence => 2); -- Make sure all data products were set in the Set_Up procedure, then clear the history for the rest of testing. Natural_Assert.Eq (T.Data_Product_T_Recv_Sync_History.Get_Count, 3); diff --git a/src/components/event_limiter/test/event_limiter_tests-implementation.ads b/src/components/event_limiter/test/event_limiter_tests-implementation.ads index a9a7112f..04510460 100644 --- a/src/components/event_limiter/test/event_limiter_tests-implementation.ads +++ b/src/components/event_limiter/test/event_limiter_tests-implementation.ads @@ -16,7 +16,7 @@ private -- This unit test is to test incrementing counters for the range events as they come in with both enabled and disabled states. overriding procedure Test_Received_Event (Self : in out Instance); - -- This unit test is to test the decrement of all the event counters in the tick and the contruction of the event if events were limited. + -- This unit test is to test the decrement of all the event counters in the tick and the construction of the event if events were limited. overriding procedure Test_Decrement_Event_Count (Self : in out Instance); -- This unit test sends the issue command and test that the appropriate values are received in that packet. overriding procedure Test_Issue_State_Packet (Self : in out Instance); diff --git a/src/components/event_limiter/two_counter_entry/test/two_counter_entry.tests.yaml b/src/components/event_limiter/two_counter_entry/test/two_counter_entry.tests.yaml index ae7f9257..56deb054 100644 --- a/src/components/event_limiter/two_counter_entry/test/two_counter_entry.tests.yaml +++ b/src/components/event_limiter/two_counter_entry/test/two_counter_entry.tests.yaml @@ -2,7 +2,7 @@ description: This is a unit test suite forthe two_counter_entry object for help with the event_limiter tests: - name: Test_Init_List - description: This test is inteded to test the different permutations of the init of the byte array. + description: This test is intended to test the different permutations of the init of the byte array. - name: Test_Increment_Count description: This unit test tests incrementing the appropriate count when given an ID. - name: Test_Decrement_Count diff --git a/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.adb b/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.adb index d8ccc1d4..d298cd0d 100644 --- a/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.adb +++ b/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.adb @@ -74,7 +74,7 @@ package body Two_Counter_Entry_Tests.Implementation is -- Last one out of range State_Return_Status := My_Counter.Get_Enable_State (6, Event_State); Event_State_Status_Assert.Eq (State_Return_Status, Two_Counter_Entry.Invalid_Id); - Event_State_Assert.Eq (Event_State, Event_State_Type.Disabled); -- Make sure we dont have something unitialized + Event_State_Assert.Eq (Event_State, Event_State_Type.Disabled); -- Make sure we dont have something uninitialized My_Counter.Destroy; -- Single event init, default list @@ -180,7 +180,7 @@ package body Two_Counter_Entry_Tests.Implementation is Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); Return_Status := My_Counter.Increment_Counter (6); -- Count = 6 Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); - -- Maxed out presistance call + -- Maxed out persistence call Return_Status := My_Counter.Increment_Counter (6); -- Count = 7 Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Event_Max_Limit); -- Checking that it should still be maxed out @@ -207,7 +207,7 @@ package body Two_Counter_Entry_Tests.Implementation is Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); Return_Status := My_Counter.Increment_Counter (5); -- Count = 6 Total of 7, Count is post incremented to 7 Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); - -- Maxed out presistance call + -- Maxed out persistence call Return_Status := My_Counter.Increment_Counter (5); -- Count = 7 Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Event_Max_Limit); -- Checking that it should still be maxed out @@ -310,7 +310,7 @@ package body Two_Counter_Entry_Tests.Implementation is Return_Status := My_Counter.Decrement_Counter (3); Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); - -- Increment and then test the return of the decrment + -- Increment and then test the return of the decrement Return_Status := My_Counter.Increment_Counter (3); Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); Return_Status := My_Counter.Increment_Counter (3); @@ -376,7 +376,7 @@ package body Two_Counter_Entry_Tests.Implementation is Return_Status := My_Counter.Decrement_Counter (4); Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Success); - -- To test that a disabled event doesnt return a max limit, we need to increment, disable the event, then decrement + -- To test that a disabled event doesn't return a max limit, we need to increment, disable the event, then decrement State_Return_Status := My_Counter.Get_Enable_State (5, Event_State); Event_State_Status_Assert.Eq (State_Return_Status, Two_Counter_Entry.Success); Event_State_Assert.Eq (Event_State, Event_State_Type.Enabled); @@ -583,7 +583,7 @@ package body Two_Counter_Entry_Tests.Implementation is Persistence := My_Counter.Get_Persistence; Natural_Assert.Eq (Natural (Persistence), 7); - -- Make sure we opperate on enabled events + -- Make sure we operate on enabled events State_Return_Status := My_Counter.Get_Enable_State (0, Event_State); Event_State_Status_Assert.Eq (State_Return_Status, Two_Counter_Entry.Success); Event_State_Assert.Eq (Event_State, Event_State_Type.Enabled); @@ -652,7 +652,7 @@ package body Two_Counter_Entry_Tests.Implementation is Return_Status := My_Counter.Increment_Counter (2); Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Event_Max_Limit); - -- Also make sure that the persistance for the last one was reset back to the limit + -- Also make sure that the persistence for the last one was reset back to the limit Return_Status := My_Counter.Decrement_Counter (0); Count_Status_Assert.Eq (Return_Status, Two_Counter_Entry.Event_Max_Limit); diff --git a/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.ads b/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.ads index 8734cdfb..fff657f7 100644 --- a/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.ads +++ b/src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.ads @@ -13,7 +13,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This test is inteded to test the different permutations of the init of the byte array. + -- This test is intended to test the different permutations of the init of the byte array. overriding procedure Test_Init_List (Self : in out Instance); -- This unit test tests incrementing the appropriate count when given an ID. overriding procedure Test_Increment_Count (Self : in out Instance); diff --git a/src/components/event_limiter/two_counter_entry/two_counter_entry.adb b/src/components/event_limiter/two_counter_entry/two_counter_entry.adb index 15d3c88a..d111e5d2 100644 --- a/src/components/event_limiter/two_counter_entry/two_counter_entry.adb +++ b/src/components/event_limiter/two_counter_entry/two_counter_entry.adb @@ -20,7 +20,7 @@ package body Two_Counter_Entry is -- Init the array so that all events are enabled by default and the counts are set to 0. Self.Bytes.all := (others => Two_Counter_Entry_Type.Serialization.To_Byte_Array ((Top_Event_Enabled_State => Event_State_Type.Enabled, Top_Event_Count => 0, Bottom_Event_Enabled_State => Event_State_Type.Enabled, Bottom_Event_Count => 0)) (0)); - -- Then disable the event baised on our disable list + -- Then disable the event based on our disable list for Event_Id_To_Disable of Event_Disable_List loop Status := Set_Enable_State (Self, Event_Id_To_Disable, Event_State_Type.Disabled); -- Assert here on status @@ -52,9 +52,9 @@ package body Two_Counter_Entry is Status : Event_Location; Increment_Status : Count_Status := Success; begin - -- Check the master state. If it is disabled then bypass all the logic for efficency + -- Check the master state. If it is disabled then bypass all the logic for efficiency if Self.Master_Enable_State = Enabled then - -- Start by range checking. If this fails we shouldnt access anything after + -- Start by range checking. If this fails we shouldn't access anything after Status := Get_Entry (Self, Id, Event_Info); case Status is @@ -124,7 +124,7 @@ package body Two_Counter_Entry is begin -- If the master state is disabled, then bypass all the logic and just return success if Self.Master_Enable_State = Enabled then - -- Start by range checking. If this fails we shouldnt access anything after + -- Start by range checking. If this fails we shouldn't access anything after Status := Get_Entry (Self, Id, Event_Info); case Status is when Invalid_Id => @@ -186,7 +186,7 @@ package body Two_Counter_Entry is Event_Info : Two_Counter_Entry_Type.T; Status : Event_Location; begin - -- Start by range checking. If this fails we shouldnt access anything after + -- Start by range checking. If this fails we shouldn't access anything after Status := Get_Entry (Self, Id, Event_Info); case Status is @@ -216,9 +216,9 @@ package body Two_Counter_Entry is Event_Info : Two_Counter_Entry_Type.T; Status : Event_Location; begin - -- Set our event state just incase we have a bad Id + -- Set our event state just in case we have a bad Id Event_State := Event_State_Type.Disabled; - -- Start by range checking. If this fails we shouldnt access anything after + -- Start by range checking. If this fails we shouldn't access anything after Status := Get_Entry (Self, Id, Event_Info); case Status is @@ -235,7 +235,7 @@ package body Two_Counter_Entry is procedure Set_Persistence (Self : in out Instance; New_Persistence : in Persistence_Type) is begin - -- If the new persistence decreases, then we need to loop through all the events and make sure the counts are less than or equal to the new persistance + -- If the new persistence decreases, then we need to loop through all the events and make sure the counts are less than or equal to the new persistence if New_Persistence < Self.Persistence then -- No need to check the id since we assume it should be in range from our init values for Idx in Self.Bytes'Range loop @@ -311,9 +311,9 @@ package body Two_Counter_Entry is Convention => Ada, Address => Self.Bytes (Event_Id_In)'Address; begin - -- Give the caller the overlayed byte so that it can be operated on and copied back in. + -- Give the caller the overlaid byte so that it can be operated on and copied back in. Event_Info := Overlay; - -- Return a Top or Bottom status so that the caller doesnt have to perfom the math on the id again and knows which half of the byte to operate on. + -- Return a Top or Bottom status so that the caller doesn't have to perform the math on the id again and knows which half of the byte to operate on. if Top_Or_Bottom = 0 then return Top; else diff --git a/src/components/event_limiter/two_counter_entry/two_counter_entry.ads b/src/components/event_limiter/two_counter_entry/two_counter_entry.ads index 3fb6c728..38adcdcc 100644 --- a/src/components/event_limiter/two_counter_entry/two_counter_entry.ads +++ b/src/components/event_limiter/two_counter_entry/two_counter_entry.ads @@ -59,7 +59,7 @@ package Two_Counter_Entry is function Get_Event_Start_Stop_Range (Self : in Instance; Event_Stop_Id : out Event_Id) return Event_Id; private - -- Helper functions to perfom range checking on the array, pass the counter data, and to rewite the values back in. Returns the entry if a valid one is found and otherwise fails with the Invalid_Id status + -- Helper functions to perform range checking on the array, pass the counter data, and to rewrite the values back in. Returns the entry if a valid one is found and otherwise fails with the Invalid_Id status function Get_Entry (Self : in Instance; Id : in Event_Id; Event_Info : out Two_Counter_Entry_Type.T) return Event_Location; procedure Set_Entry (Self : in out Instance; Id : in Event_Id; Event_New_Info : in Two_Counter_Entry_Type.T); diff --git a/src/components/event_packetizer/component-event_packetizer-implementation.ads b/src/components/event_packetizer/component-event_packetizer-implementation.ads index 951df11b..393fd6f2 100644 --- a/src/components/event_packetizer/component-event_packetizer-implementation.ads +++ b/src/components/event_packetizer/component-event_packetizer-implementation.ads @@ -68,7 +68,7 @@ private type Instance is new Event_Packetizer.Base_Instance with record -- Internal packets: Packet_Array : Protected_Packet_Array; - -- Partial packet count - how many ticks have pased while component + -- Partial packet count - how many ticks have passed while component -- has held a partial packet. Partial_Packet_Count : Natural := 0; Partial_Packet_Timeout : Natural := 0; diff --git a/src/components/event_packetizer/test/event_packetizer.tests.yaml b/src/components/event_packetizer/test/event_packetizer.tests.yaml index d9ed7c90..696e8a2f 100644 --- a/src/components/event_packetizer/test/event_packetizer.tests.yaml +++ b/src/components/event_packetizer/test/event_packetizer.tests.yaml @@ -2,14 +2,14 @@ description: This is a unit test suite for the Event Packetizer component tests: - name: Test_Nominal_Packetization - description: This unit test excersizes the nominal behavior of the event packetizer with 3 internal packets. + description: This unit test exercises the nominal behavior of the event packetizer with 3 internal packets. - name: Test_Partial_Packet_Timeout - description: This unit test excersizes the partial packet timeout feature. + description: This unit test exercises the partial packet timeout feature. - name: Test_Partial_Packet_Timeout_Of_1 - description: This unit test excersizes the partial packet timeout feature with value set to 1, which means timeout should always occur. + description: This unit test exercises the partial packet timeout feature with value set to 1, which means timeout should always occur. - name: Test_Commanded_Packetization description: This unit test tells the packetizer to packetize a partial packet via command. - name: Test_Dropped_Events - description: This unit test excersizes the behavior of the packetizer when it is so full that events begin getting dropped. + description: This unit test exercises the behavior of the packetizer when it is so full that events begin getting dropped. - name: Uninitialized - description: This unit test excersizes the behavior of the packetizer when it is uninitialized. + description: This unit test exercises the behavior of the packetizer when it is uninitialized. diff --git a/src/components/event_packetizer/test/event_packetizer_tests-implementation.adb b/src/components/event_packetizer/test/event_packetizer_tests-implementation.adb index 2a9e01bf..27057fd3 100644 --- a/src/components/event_packetizer/test/event_packetizer_tests-implementation.adb +++ b/src/components/event_packetizer/test/event_packetizer_tests-implementation.adb @@ -85,7 +85,7 @@ package body Event_Packetizer_Tests.Implementation is P_Idx : Natural; Bytes_Sent : Natural := 0; begin - -- Intialize the component with 2 internal packets, and no packet timeout: + -- Initialize the component with 2 internal packets, and no packet timeout: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 0); -- Send some ticks and expect no packets: @@ -215,7 +215,7 @@ package body Event_Packetizer_Tests.Implementation is The_Packet : Packet.T; P_Idx : Natural; begin - -- Intialize the component with 2 internal packets, and a packet timeout of 3 ticks: + -- Initialize the component with 2 internal packets, and a packet timeout of 3 ticks: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 3); -- Send some ticks and expect no packets: @@ -298,7 +298,7 @@ package body Event_Packetizer_Tests.Implementation is The_Packet : Packet.T; P_Idx : Natural; begin - -- Intialize the component with 2 internal packets, and a packet timeout of 3 ticks: + -- Initialize the component with 2 internal packets, and a packet timeout of 3 ticks: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 1); -- Send some ticks and expect no packets: @@ -374,7 +374,7 @@ package body Event_Packetizer_Tests.Implementation is P_Idx : Natural; Commands : Event_Packetizer_Commands.Instance renames Self.Tester.Commands; begin - -- Intialize the component with 2 internal packets, and a disabled packet timeout: + -- Initialize the component with 2 internal packets, and a disabled packet timeout: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 0); -- Send some ticks and expect no packets: @@ -493,7 +493,7 @@ package body Event_Packetizer_Tests.Implementation is P_Idx : Natural; Bytes_Sent : Natural := 0; begin - -- Intialize the component with 2 internal packets, and no packet timeout: + -- Initialize the component with 2 internal packets, and no packet timeout: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 0); -- OK, fill up a packet, and make sure that no packets are dropped: @@ -633,7 +633,7 @@ package body Event_Packetizer_Tests.Implementation is T.Event_T_Send (Event_2); T.Event_T_Send (Event_2); - -- Intialize the component with 2 internal packets, and no packet timeout: + -- Initialize the component with 2 internal packets, and no packet timeout: T.Component_Instance.Init (Num_Internal_Packets => 2, Partial_Packet_Timeout => 0); -- Send tick and expect data product to be emitted: diff --git a/src/components/event_packetizer/test/event_packetizer_tests-implementation.ads b/src/components/event_packetizer/test/event_packetizer_tests-implementation.ads index 5118e6d3..83505e0f 100644 --- a/src/components/event_packetizer/test/event_packetizer_tests-implementation.ads +++ b/src/components/event_packetizer/test/event_packetizer_tests-implementation.ads @@ -11,17 +11,17 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the nominal behavior of the event packetizer with a single internal packet. + -- This unit test exercises the nominal behavior of the event packetizer with a single internal packet. overriding procedure Test_Nominal_Packetization (Self : in out Instance); - -- This unit test excersizes the partial packet timeout feature. + -- This unit test exercises the partial packet timeout feature. overriding procedure Test_Partial_Packet_Timeout (Self : in out Instance); - -- This unit test excersizes the partial packet timeout feature with value set to 1, which means timeout should always occur. + -- This unit test exercises the partial packet timeout feature with value set to 1, which means timeout should always occur. overriding procedure Test_Partial_Packet_Timeout_Of_1 (Self : in out Instance); -- This unit test tells the packetizer to packetize a partial packet via command. overriding procedure Test_Commanded_Packetization (Self : in out Instance); - -- This unit test excersizes the behavior of the packetizer when it is so full that events begin getting dropped. + -- This unit test exercises the behavior of the packetizer when it is so full that events begin getting dropped. overriding procedure Test_Dropped_Events (Self : in out Instance); - -- This unit test excersizes the behavior of the packetizer when it is uninitialized. + -- This unit test exercises the behavior of the packetizer when it is uninitialized. overriding procedure Uninitialized (Self : in out Instance); -- Test data and state: diff --git a/src/components/fault_correction/component-fault_correction-implementation.adb b/src/components/fault_correction/component-fault_correction-implementation.adb index 943404de..a5cde521 100644 --- a/src/components/fault_correction/component-fault_correction-implementation.adb +++ b/src/components/fault_correction/component-fault_correction-implementation.adb @@ -195,7 +195,7 @@ package body Component.Fault_Correction.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); @@ -460,7 +460,7 @@ package body Component.Fault_Correction.Implementation is Self.Data_Product_T_Send_If_Connected (Self.Data_Products.Last_Fault_Id_Received (The_Time, (Id => Fault_Id'First))); Self.Data_Product_T_Send_If_Connected (Self.Data_Products.Time_Of_Last_Fault_Received (The_Time, (0, 0))); - -- Send infomational event saying that we got the command. + -- Send informational event saying that we got the command. Self.Event_T_Send_If_Connected (Self.Events.Data_Products_Reset (The_Time)); return Success; end Reset_Data_Products; diff --git a/src/components/fault_correction/component-fault_correction-implementation.ads b/src/components/fault_correction/component-fault_correction-implementation.ads index 54970ab8..8d7da767 100644 --- a/src/components/fault_correction/component-fault_correction-implementation.ads +++ b/src/components/fault_correction/component-fault_correction-implementation.ads @@ -80,7 +80,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); diff --git a/src/components/fault_correction/fault_correction.component.yaml b/src/components/fault_correction/fault_correction.component.yaml index 1656a556..e5beeccd 100644 --- a/src/components/fault_correction/fault_correction.component.yaml +++ b/src/components/fault_correction/fault_correction.component.yaml @@ -9,7 +9,7 @@ init: type: Fault_Correction_Types.Fault_Response_Config_List description: "An access to a list of fault response configurations." connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: This connector is used to send command responses. diff --git a/src/components/fault_correction/test/test_component/test_component.component.yaml b/src/components/fault_correction/test/test_component/test_component.component.yaml index 4a9e05db..6ab25512 100644 --- a/src/components/fault_correction/test/test_component/test_component.component.yaml +++ b/src/components/fault_correction/test/test_component/test_component.component.yaml @@ -2,7 +2,7 @@ description: A simple component which throws faults and receives commands to help simulate an assembly that has both features. execution: passive connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to send command responses. diff --git a/src/components/fault_correction/types/fault_correction_enums.enums.yaml b/src/components/fault_correction/types/fault_correction_enums.enums.yaml index 2ac7b20f..54ec3d7a 100644 --- a/src/components/fault_correction/types/fault_correction_enums.enums.yaml +++ b/src/components/fault_correction/types/fault_correction_enums.enums.yaml @@ -33,4 +33,4 @@ enums: description: A fault has been detected and a command response has been issued. - name: Fault_Latched value: 3 - description: A fault has been detected and a command response has been issued. The fualt has been latched, so any more faults received with this ID will not issue another response until the this fault response has been unlatched. + description: A fault has been detected and a command response has been issued. The fault has been latched, so any more faults received with this ID will not issue another response until the this fault response has been unlatched. diff --git a/src/components/forwarder/forwarder.component.yaml b/src/components/forwarder/forwarder.component.yaml index bb632414..326ef092 100644 --- a/src/components/forwarder/forwarder.component.yaml +++ b/src/components/forwarder/forwarder.component.yaml @@ -28,7 +28,7 @@ connectors: - description: The connector for data products type: Data_Product.T kind: send - - description: The event connector to send the events specifc to the component. + - description: The event connector to send the events specific to the component. type: Event.T kind: send - description: The system time is retrieved via this connector. diff --git a/src/components/forwarder/test/component-forwarder-implementation-tester.adb b/src/components/forwarder/test/component-forwarder-implementation-tester.adb index 60aea31c..4d6451d9 100644 --- a/src/components/forwarder/test/component-forwarder-implementation-tester.adb +++ b/src/components/forwarder/test/component-forwarder-implementation-tester.adb @@ -81,7 +81,7 @@ package body Component.Forwarder.Implementation.Tester is Self.Dispatch_Data_Product (Arg); end Data_Product_T_Recv_Sync; - -- The event connector to send the events specifc to the component. + -- The event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/forwarder/test/component-forwarder-implementation-tester.ads b/src/components/forwarder/test/component-forwarder-implementation-tester.ads index ba7b3911..9498b688 100644 --- a/src/components/forwarder/test/component-forwarder-implementation-tester.ads +++ b/src/components/forwarder/test/component-forwarder-implementation-tester.ads @@ -75,7 +75,7 @@ package Component.Forwarder.Implementation.Tester is overriding procedure Command_Response_T_Recv_Sync (Self : in out Instance; Arg : in Command_Response.T); -- The connector for data products overriding procedure Data_Product_T_Recv_Sync (Self : in out Instance; Arg : in Data_Product.T); - -- The event connector to send the events specifc to the component. + -- The event connector to send the events specific to the component. overriding procedure Event_T_Recv_Sync (Self : in out Instance; Arg : in Event.T); -- The system time is retrieved via this connector. overriding function Sys_Time_T_Return (Self : in out Instance) return Sys_Time.T; diff --git a/src/components/interrupt_listener/component-interrupt_listener-implementation.ads b/src/components/interrupt_listener/component-interrupt_listener-implementation.ads index 07898b22..12fd0d1e 100644 --- a/src/components/interrupt_listener/component-interrupt_listener-implementation.ads +++ b/src/components/interrupt_listener/component-interrupt_listener-implementation.ads @@ -6,7 +6,7 @@ with System; with Ada.Interrupts; --- This is the Interrupt Listener component. It is attached to an interrupt and provides a connector which will give the caller a count. The count includes the number of times the interrupt has occured since the last invokation of the connector. If the count reaches the maximum of a Natural, it stops incremending. This component should be made passive in order to function properly. +-- This is the Interrupt Listener component. It is attached to an interrupt and provides a connector which will give the caller a count. The count includes the number of times the interrupt has occurred since the last invocation of the connector. If the count reaches the maximum of a Natural, it stops incremending. This component should be made passive in order to function properly. generic package Component.Interrupt_Listener.Implementation is diff --git a/src/components/interrupt_listener/test/component-interrupt_listener-implementation-tester.ads b/src/components/interrupt_listener/test/component-interrupt_listener-implementation-tester.ads index 9cde2ce6..1d5ab968 100644 --- a/src/components/interrupt_listener/test/component-interrupt_listener-implementation-tester.ads +++ b/src/components/interrupt_listener/test/component-interrupt_listener-implementation-tester.ads @@ -7,7 +7,7 @@ with Component.Interrupt_Listener_Reciprocal; with System; with Ada.Interrupts.Names; --- This is the Interrupt Listener component. This component contains an internal piece of data (of generic type) which should be altered by a custom interrupt procedure passed in at instantiation. External components can request the latest version of this data at any time. A common use for this component might be to manage a counter, where the custom procedure increments the count with each interrupt, and the requestor of the count uses the count to determine if an interrupt has been received. +-- This is the Interrupt Listener component. This component contains an internal piece of data (of generic type) which should be altered by a custom interrupt procedure passed in at instantiation. External components can request the latest version of this data at any time. A common use for this component might be to manage a counter, where the custom procedure increments the count with each interrupt, and the requester of the count uses the count to determine if an interrupt has been received. generic package Component.Interrupt_Listener.Implementation.Tester is diff --git a/src/components/interrupt_pender/component-interrupt_pender-implementation.ads b/src/components/interrupt_pender/component-interrupt_pender-implementation.ads index bb599cc5..446e5ec4 100644 --- a/src/components/interrupt_pender/component-interrupt_pender-implementation.ads +++ b/src/components/interrupt_pender/component-interrupt_pender-implementation.ads @@ -6,7 +6,7 @@ with Ada.Interrupts; with System; --- This is the Interrupt Pender component. It is attached to an interrupt and provides a connector which will block any component that invokes it until an interrupt is triggered. When an interrup occures the component will return a Tick to the waiting component. This component should be made passive in order to function properly. +-- This is the Interrupt Pender component. It is attached to an interrupt and provides a connector which will block any component that invokes it until an interrupt is triggered. When an interrupt occurs the component will return a Tick to the waiting component. This component should be made passive in order to function properly. generic package Component.Interrupt_Pender.Implementation is diff --git a/src/components/interrupt_pender/test/component-interrupt_pender-implementation-tester.ads b/src/components/interrupt_pender/test/component-interrupt_pender-implementation-tester.ads index 4963d52d..9a7987ce 100644 --- a/src/components/interrupt_pender/test/component-interrupt_pender-implementation-tester.ads +++ b/src/components/interrupt_pender/test/component-interrupt_pender-implementation-tester.ads @@ -11,7 +11,7 @@ with Ada.Interrupts.Names; -- Invokee Connector Includes: --- This is the Interrupt Pender component. It is attached to an interrupt and provides a connector which will block any component that invokes it until an interrupt is triggered. When an interrup occurs the component will return a Tick to the waiting component. This component should be made passive in order to function properly. +-- This is the Interrupt Pender component. It is attached to an interrupt and provides a connector which will block any component that invokes it until an interrupt is triggered. When an interrupt occurs the component will return a Tick to the waiting component. This component should be made passive in order to function properly. generic package Component.Interrupt_Pender.Implementation.Tester is diff --git a/src/components/interrupt_servicer/component-interrupt_servicer-implementation.ads b/src/components/interrupt_servicer/component-interrupt_servicer-implementation.ads index 773a3d6c..d8ac1c7b 100644 --- a/src/components/interrupt_servicer/component-interrupt_servicer-implementation.ads +++ b/src/components/interrupt_servicer/component-interrupt_servicer-implementation.ads @@ -6,7 +6,7 @@ with Ada.Interrupts; with System; --- This is the Interrupt Servicer component. It is attached to an interrupt and sends out a Tick.T everytime the interrupt is triggered. This component MUST be made active in order to function properly. +-- This is the Interrupt Servicer component. It is attached to an interrupt and sends out a Tick.T every time the interrupt is triggered. This component MUST be made active in order to function properly. generic package Component.Interrupt_Servicer.Implementation is diff --git a/src/components/interrupt_servicer/interrupt_servicer.component.yaml b/src/components/interrupt_servicer/interrupt_servicer.component.yaml index b6530df7..95be5d08 100644 --- a/src/components/interrupt_servicer/interrupt_servicer.component.yaml +++ b/src/components/interrupt_servicer/interrupt_servicer.component.yaml @@ -1,5 +1,5 @@ --- -description: The Interrupt Servicer provides a task that an attached component executes on when an interrupt is received. The component is attached to an interrupt. When it receives the interrupt, the component's internal task is released, and the component calls the Interrupt_Data_Type_Send connector causing an attached component to execute on its internal task. A user-defined generic data type is passed between the Interrupt Servicer and the connected component. This data type will usually be filled in within a user defined custom interrupt handler, provided to the Interrupt Servicer at instatiation, and called by the Interrupt Servicer every time the specified interrupt is received. +description: The Interrupt Servicer provides a task that an attached component executes on when an interrupt is received. The component is attached to an interrupt. When it receives the interrupt, the component's internal task is released, and the component calls the Interrupt_Data_Type_Send connector causing an attached component to execute on its internal task. A user-defined generic data type is passed between the Interrupt Servicer and the connected component. This data type will usually be filled in within a user defined custom interrupt handler, provided to the Interrupt Servicer at instantiation, and called by the Interrupt Servicer every time the specified interrupt is received. execution: active with: - Interrupt_Handlers diff --git a/src/components/interrupt_servicer/test/component-interrupt_servicer-implementation-tester.ads b/src/components/interrupt_servicer/test/component-interrupt_servicer-implementation-tester.ads index 25e92df3..a115bd3c 100644 --- a/src/components/interrupt_servicer/test/component-interrupt_servicer-implementation-tester.ads +++ b/src/components/interrupt_servicer/test/component-interrupt_servicer-implementation-tester.ads @@ -8,7 +8,7 @@ with Sys_Time; with System; with Ada.Interrupts.Names; --- This is the Interrupt Servicer component. It is attached to an interrupt and sends out a Tick.T everytime the interrupt is triggered. This component MUST be made active in order to function properly. +-- This is the Interrupt Servicer component. It is attached to an interrupt and sends out a Tick.T every time the interrupt is triggered. This component MUST be made active in order to function properly. generic package Component.Interrupt_Servicer.Implementation.Tester is diff --git a/src/components/last_chance_manager/last_chance_manager.requirements.yaml b/src/components/last_chance_manager/last_chance_manager.requirements.yaml index 06317f79..09e57b0e 100644 --- a/src/components/last_chance_manager/last_chance_manager.requirements.yaml +++ b/src/components/last_chance_manager/last_chance_manager.requirements.yaml @@ -1,6 +1,6 @@ --- description: The requirements for the Last Chance Handler component. requirements: - - text: The component shall provide a nonvolatile last chance handler memory region, where exception occurance data is can be stored by the last chance handler. + - text: The component shall provide a nonvolatile last chance handler memory region, where exception occurrence data is can be stored by the last chance handler. - text: The component shall provide a command to dump the last chance handler memory region. - text: The component shall provide a command to clear the last chance handler memory region. diff --git a/src/components/limiter/component-limiter-implementation.ads b/src/components/limiter/component-limiter-implementation.ads index a0ee3801..6dd43fa0 100644 --- a/src/components/limiter/component-limiter-implementation.ads +++ b/src/components/limiter/component-limiter-implementation.ads @@ -7,7 +7,7 @@ with Command; with Parameter; with Protected_Variables; --- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data theourh a "send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be ommitted if these features are not used. +-- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data theourh a "send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be omitted if these features are not used. generic package Component.Limiter.Implementation is diff --git a/src/components/limiter/limiter.component.yaml b/src/components/limiter/limiter.component.yaml index b2781e8d..649245fd 100644 --- a/src/components/limiter/limiter.component.yaml +++ b/src/components/limiter/limiter.component.yaml @@ -1,5 +1,5 @@ --- -description: This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be ommitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. +description: This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be omitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. execution: passive with: - Serializer_Types diff --git a/src/components/limiter/test/component-limiter-implementation-tester.ads b/src/components/limiter/test/component-limiter-implementation-tester.ads index 41bf891d..fb24926e 100644 --- a/src/components/limiter/test/component-limiter-implementation-tester.ads +++ b/src/components/limiter/test/component-limiter-implementation-tester.ads @@ -17,7 +17,7 @@ with Invalid_Command_Info.Representation; with Invalid_Parameter_Info.Representation; with Data_Product; --- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be ommitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. +-- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be omitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. generic package Component.Limiter.Implementation.Tester is diff --git a/src/components/limiter/test/limiter.tests.yaml b/src/components/limiter/test/limiter.tests.yaml index ae7960c7..daa03ce6 100644 --- a/src/components/limiter/test/limiter.tests.yaml +++ b/src/components/limiter/test/limiter.tests.yaml @@ -2,11 +2,11 @@ description: This is a unit test suite for the Limiter component tests: - name: Test_Nominal_Limiting - description: This unit test excersizes the limiter component, making sure it behaves as expected. + description: This unit test exercises the limiter component, making sure it behaves as expected. - name: Test_Change_Rate_Command - description: This unit test excersizes the change rate command of the limiter and makes sure it works. + description: This unit test exercises the change rate command of the limiter and makes sure it works. - name: Test_Change_Rate_Parameter - description: This unit test excersizes the change rate parameter of the limiter and makes sure it works. + description: This unit test exercises the change rate parameter of the limiter and makes sure it works. - name: Test_Queue_Overflow description: This unit test exercises that a queue overflow results in the appropriate event. - name: Test_Invalid_Command diff --git a/src/components/limiter/test/limiter_tests-implementation.ads b/src/components/limiter/test/limiter_tests-implementation.ads index 423f8c5a..5c0a39ef 100644 --- a/src/components/limiter/test/limiter_tests-implementation.ads +++ b/src/components/limiter/test/limiter_tests-implementation.ads @@ -15,11 +15,11 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the limiter component, making sure it behaves as expected. + -- This unit test exercises the limiter component, making sure it behaves as expected. overriding procedure Test_Nominal_Limiting (Self : in out Instance); - -- This unit test excersizes the change rate command of the limiter and makes sure it works. + -- This unit test exercises the change rate command of the limiter and makes sure it works. overriding procedure Test_Change_Rate_Command (Self : in out Instance); - -- This unit test excersizes the change rate parameter of the limiter and makes sure it works. + -- This unit test exercises the change rate parameter of the limiter and makes sure it works. overriding procedure Test_Change_Rate_Parameter (Self : in out Instance); -- This unit test exercises that a queue overflow results in the appropriate event. overriding procedure Test_Queue_Overflow (Self : in out Instance); diff --git a/src/components/limiter/test_variable/component-limiter-implementation-tester.ads b/src/components/limiter/test_variable/component-limiter-implementation-tester.ads index 41bf891d..fb24926e 100644 --- a/src/components/limiter/test_variable/component-limiter-implementation-tester.ads +++ b/src/components/limiter/test_variable/component-limiter-implementation-tester.ads @@ -17,7 +17,7 @@ with Invalid_Command_Info.Representation; with Invalid_Parameter_Info.Representation; with Data_Product; --- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be ommitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. +-- This is the limiter component. This component receives a generic type of data and queues that data. It then meters the output of the data through a ``send" connector at a commandable rate. The rate is set upon initialization, can be changed by command, or by parameter. The command or parameter connections may be omitted if one or both of these features are not used. The packet rate is in units of the periodic tick rate that drives the component. generic package Component.Limiter.Implementation.Tester is diff --git a/src/components/limiter/test_variable/variable_tests-implementation.ads b/src/components/limiter/test_variable/variable_tests-implementation.ads index b438f233..faa9758c 100644 --- a/src/components/limiter/test_variable/variable_tests-implementation.ads +++ b/src/components/limiter/test_variable/variable_tests-implementation.ads @@ -15,7 +15,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes the limiter component while queueing variable length packets. + -- This unit test exercises the limiter component while queueing variable length packets. overriding procedure Test_Queueing_Variable_Length (Self : in out Instance); -- Instantiate generic component package: diff --git a/src/components/limiter/test_variable/variable_tests.limiter.tests.yaml b/src/components/limiter/test_variable/variable_tests.limiter.tests.yaml index 8cd56c98..c8634d10 100644 --- a/src/components/limiter/test_variable/variable_tests.limiter.tests.yaml +++ b/src/components/limiter/test_variable/variable_tests.limiter.tests.yaml @@ -2,4 +2,4 @@ description: This is unit test suite tests out the variable queueing of a generic component. The purpose of this unit test is not to test the limiter specifically, but the autocoding logic of a generic asynchronous connector of variable length type. tests: - name: Test_Queueing_Variable_Length - description: This unit test excersizes the limiter component while queueing variable length packets. + description: This unit test exercises the limiter component while queueing variable length packets. diff --git a/src/components/memory_copier/component-memory_copier-implementation.adb b/src/components/memory_copier/component-memory_copier-implementation.adb index cc5bddb0..b37c1399 100644 --- a/src/components/memory_copier/component-memory_copier-implementation.adb +++ b/src/components/memory_copier/component-memory_copier-implementation.adb @@ -85,7 +85,7 @@ package body Component.Memory_Copier.Implementation is -- Request the source memory region: Request : constant Memory_Region_Request.T := Self.Memory_Region_Request_T_Get; -- Calculate the minimum length that the requested region must have in order for - -- the vitual memoy region to be valid. + -- the virtual memoy region to be valid. Min_Length : constant Natural := Virtual_Region.Address + Virtual_Region.Length; begin -- Check the request memory status: diff --git a/src/components/memory_copier/memory_copier.events.yaml b/src/components/memory_copier/memory_copier.events.yaml index 8c23f49e..5eec8258 100644 --- a/src/components/memory_copier/memory_copier.events.yaml +++ b/src/components/memory_copier/memory_copier.events.yaml @@ -16,7 +16,7 @@ events: description: A command was received with invalid parameters. param_type: Invalid_Command_Info.T - name: Copy_Timeout - description: A timeout occured while waiting for a copy operation to complete. + description: A timeout occurred while waiting for a copy operation to complete. - name: Copy_Failure description: A copy failed. param_type: Memory_Region_Release.T diff --git a/src/components/memory_copier/test/component-memory_copier-implementation-tester.adb b/src/components/memory_copier/test/component-memory_copier-implementation-tester.adb index 48aaccae..e059522c 100644 --- a/src/components/memory_copier/test/component-memory_copier-implementation-tester.adb +++ b/src/components/memory_copier/test/component-memory_copier-implementation-tester.adb @@ -182,7 +182,7 @@ package body Component.Memory_Copier.Implementation.Tester is Self.Invalid_Command_Received_History.Push (Arg); end Invalid_Command_Received; - -- A timeout occured while waiting for a copy operation to complete. + -- A timeout occurred while waiting for a copy operation to complete. overriding procedure Copy_Timeout (Self : in out Instance) is Arg : constant Natural := 0; begin diff --git a/src/components/memory_copier/test/component-memory_copier-implementation-tester.ads b/src/components/memory_copier/test/component-memory_copier-implementation-tester.ads index 7289ecd1..32a263ec 100644 --- a/src/components/memory_copier/test/component-memory_copier-implementation-tester.ads +++ b/src/components/memory_copier/test/component-memory_copier-implementation-tester.ads @@ -119,7 +119,7 @@ package Component.Memory_Copier.Implementation.Tester is overriding procedure Finished_Copy (Self : in out Instance; Arg : in Virtual_Memory_Region_Copy.T); -- A command was received with invalid parameters. overriding procedure Invalid_Command_Received (Self : in out Instance; Arg : in Invalid_Command_Info.T); - -- A timeout occured while waiting for a copy operation to complete. + -- A timeout occurred while waiting for a copy operation to complete. overriding procedure Copy_Timeout (Self : in out Instance); -- A copy failed. overriding procedure Copy_Failure (Self : in out Instance; Arg : in Memory_Region_Release.T); diff --git a/src/components/memory_dumper/component-memory_dumper-implementation.adb b/src/components/memory_dumper/component-memory_dumper-implementation.adb index ec5c1f6e..7eeafa61 100644 --- a/src/components/memory_dumper/component-memory_dumper-implementation.adb +++ b/src/components/memory_dumper/component-memory_dumper-implementation.adb @@ -26,7 +26,7 @@ package body Component.Memory_Dumper.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/memory_dumper/component-memory_dumper-implementation.ads b/src/components/memory_dumper/component-memory_dumper-implementation.ads index 53c482d9..cd9e6c8e 100644 --- a/src/components/memory_dumper/component-memory_dumper-implementation.ads +++ b/src/components/memory_dumper/component-memory_dumper-implementation.ads @@ -31,7 +31,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T) is null; diff --git a/src/components/memory_dumper/memory_dumper.component.yaml b/src/components/memory_dumper/memory_dumper.component.yaml index a241379e..7e180ced 100644 --- a/src/components/memory_dumper/memory_dumper.component.yaml +++ b/src/components/memory_dumper/memory_dumper.component.yaml @@ -9,7 +9,7 @@ init: type: Memory_Manager_Types.Memory_Region_Array_Access description: An access to a list of memory regions. connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/memory_dumper/test/memory_dumper.tests.yaml b/src/components/memory_dumper/test/memory_dumper.tests.yaml index 1db59a81..3f697ded 100644 --- a/src/components/memory_dumper/test/memory_dumper.tests.yaml +++ b/src/components/memory_dumper/test/memory_dumper.tests.yaml @@ -2,10 +2,10 @@ description: This is a unit test suite for the Memory Dumper component tests: - name: Test_Nominal_Dumping - description: This unit test excersizes dumping a valid region of memory managed by the component + description: This unit test exercises dumping a valid region of memory managed by the component - name: Test_Memory_Crc - description: This unit test excersizes CRCing from a valid region of memory + description: This unit test exercises CRCing from a valid region of memory - name: Test_Invalid_Address - description: This unit test excersizes dumping and CRCing from an invalid region of memory + description: This unit test exercises dumping and CRCing from an invalid region of memory - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. diff --git a/src/components/memory_dumper/test/memory_dumper_tests-implementation.ads b/src/components/memory_dumper/test/memory_dumper_tests-implementation.ads index 8912ff89..667226f8 100644 --- a/src/components/memory_dumper/test/memory_dumper_tests-implementation.ads +++ b/src/components/memory_dumper/test/memory_dumper_tests-implementation.ads @@ -11,11 +11,11 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes dumping a valid region of memory managed by the component + -- This unit test exercises dumping a valid region of memory managed by the component overriding procedure Test_Nominal_Dumping (Self : in out Instance); - -- This unit test excersizes CRCing from a valid region of memory + -- This unit test exercises CRCing from a valid region of memory overriding procedure Test_Memory_Crc (Self : in out Instance); - -- This unit test excersizes dumping and CRCing from an invalid region of memory + -- This unit test exercises dumping and CRCing from an invalid region of memory overriding procedure Test_Invalid_Address (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); diff --git a/src/components/memory_manager/component-memory_manager-implementation.adb b/src/components/memory_manager/component-memory_manager-implementation.adb index d46b7bf4..c164a38b 100644 --- a/src/components/memory_manager/component-memory_manager-implementation.adb +++ b/src/components/memory_manager/component-memory_manager-implementation.adb @@ -42,7 +42,7 @@ package body Component.Memory_Manager.Implementation is end Request; -- Release access with a given ID. If status is set to true then the release - -- succeded, otherwise an unexpected ID was returned. + -- succeeded, otherwise an unexpected ID was returned. procedure Release (Self : in out Instance; Id : in Unsigned_16; State : out Memory_Manager_Enums.Memory_State.E; Status : out Release_Status) is use Memory_Manager_Enums.Memory_State; Expected_Id : constant Unsigned_16 := Current_Id - 1; @@ -351,7 +351,7 @@ package body Component.Memory_Manager.Implementation is return Failure; end Write_Memory_Region; - -- Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomolous condition. + -- Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomalous condition. overriding function Force_Release (Self : in out Instance) return Command_Execution_Status.E is use Command_Execution_Status; begin diff --git a/src/components/memory_manager/component-memory_manager-implementation.ads b/src/components/memory_manager/component-memory_manager-implementation.ads index 6439b80f..3e0c5c2a 100644 --- a/src/components/memory_manager/component-memory_manager-implementation.ads +++ b/src/components/memory_manager/component-memory_manager-implementation.ads @@ -8,7 +8,7 @@ with Ided_Memory_Region; with Command; with Memory_Manager_Enums; --- The component manages access to a single memory location through a single pointer. When requested, the component loans out access to the pointer if it is available. The length of the pointer will always be the entire length of the memory region. The component will reject any requests to access the pointer again until the pointer is returned from the requestor. Request/release memory transactions are each provided a unique ID. To release the memory, the same ID must be provided that was issues upon request. This mechanism reduces the risk of an inadvertant call to release from causing an unintended release of the memory. The component includes a data product relating whether the memory is currently allocated or not. The component responds to commands to CRC, dump, and force-release the memory region. Note that this component is active only to provide a seperate thread of execution on which to execute the CRC command, which could take a long time to execute. +-- The component manages access to a single memory location through a single pointer. When requested, the component loans out access to the pointer if it is available. The length of the pointer will always be the entire length of the memory region. The component will reject any requests to access the pointer again until the pointer is returned from the requester. Request/release memory transactions are each provided a unique ID. To release the memory, the same ID must be provided that was issues upon request. This mechanism reduces the risk of an inadvertent call to release from causing an unintended release of the memory. The component includes a data product relating whether the memory is currently allocated or not. The component responds to commands to CRC, dump, and force-release the memory region. Note that this component is active only to provide a separate thread of execution on which to execute the CRC command, which could take a long time to execute. package Component.Memory_Manager.Implementation is -- The component class instance record: @@ -35,7 +35,7 @@ private -- Request access. If status is set to true then a unique ID is returned. procedure Request (Self : in out Instance; Id : out Unsigned_16; State : out Memory_Manager_Enums.Memory_State.E; Status : out Request_Status); -- Release access with a given ID. If status is set to true then the release - -- succeded, otherwise an unexpected ID was returned. + -- succeeded, otherwise an unexpected ID was returned. procedure Release (Self : in out Instance; Id : in Unsigned_16; State : out Memory_Manager_Enums.Memory_State.E; Status : out Release_Status); -- Release access, no ID needed. procedure Force_Release (Self : in out Instance); @@ -54,7 +54,7 @@ private -- The (protected) arbiter object for the virtual memory region: Arbiter : Protected_Memory_Arbiter; -- A copy of the memory region managed in "bytes" for efficient - -- returning to requestors. + -- returning to requesters. Region : Memory_Region.T; Virtual_Region : Virtual_Memory_Region_Positive.T; end record; @@ -108,7 +108,7 @@ private overriding function Crc_Memory_Region_Bytes (Self : in out Instance; Arg : in Virtual_Memory_Region_Positive.T) return Command_Execution_Status.E; -- Perform a write to the memory region at the provided address. If the memory is not available an error event will be produced. overriding function Write_Memory_Region (Self : in out Instance; Arg : in Virtual_Memory_Region_Write.T) return Command_Execution_Status.E; - -- Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomolous condition. + -- Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomalous condition. overriding function Force_Release (Self : in out Instance) return Command_Execution_Status.E; -- Invalid command handler. This procedure is called when a command's arguments are found to be invalid: diff --git a/src/components/memory_manager/memory_manager.commands.yaml b/src/components/memory_manager/memory_manager.commands.yaml index ff7ee408..8cf78fbf 100644 --- a/src/components/memory_manager/memory_manager.commands.yaml +++ b/src/components/memory_manager/memory_manager.commands.yaml @@ -13,4 +13,4 @@ commands: description: Perform a write to the memory region at the provided address. If the memory is not available an error event will be produced. arg_type: Virtual_Memory_Region_Write.T - name: Force_Release - description: Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomolous condition. + description: Forces the release of the memory region if it is currently allocated. This command can be used to recover from an anomalous condition. diff --git a/src/components/memory_manager/test/component-memory_manager-implementation-tester.ads b/src/components/memory_manager/test/component-memory_manager-implementation-tester.ads index 6be32a98..36827a42 100644 --- a/src/components/memory_manager/test/component-memory_manager-implementation-tester.ads +++ b/src/components/memory_manager/test/component-memory_manager-implementation-tester.ads @@ -25,7 +25,7 @@ with Command_Header.Representation; with Packet.Representation; with History; --- The component manages access to a single memory location through a single pointer. When requested, the component loans out access to the pointer if it is available. The length of the pointer will always be the entire length of the memory region. The component will reject any requests to access the pointer again until the pointer is returned from the requestor. Request/release memory transactions are each provided a unique ID. To release the memory, the same ID must be provided that was issues upon request. This mechanism reduces the risk of an inadvertant call to release from causing an unintended release of the memory. The component includes a data product relating whether the memory is currently allocated or not. The component responds to commands to CRC, dump, write, and force-release the memory region. Note that this component is active only to provide a seperate thread of execution on which to execute the CRC command and the memory write command, each which could take a long time to execute. +-- The component manages access to a single memory location through a single pointer. When requested, the component loans out access to the pointer if it is available. The length of the pointer will always be the entire length of the memory region. The component will reject any requests to access the pointer again until the pointer is returned from the requester. Request/release memory transactions are each provided a unique ID. To release the memory, the same ID must be provided that was issues upon request. This mechanism reduces the risk of an inadvertent call to release from causing an unintended release of the memory. The component includes a data product relating whether the memory is currently allocated or not. The component responds to commands to CRC, dump, write, and force-release the memory region. Note that this component is active only to provide a separate thread of execution on which to execute the CRC command and the memory write command, each which could take a long time to execute. package Component.Memory_Manager.Implementation.Tester is use Component.Memory_Manager_Reciprocal; diff --git a/src/components/memory_manager/test/memory_manager.tests.yaml b/src/components/memory_manager/test/memory_manager.tests.yaml index 2bf834e2..de8f8707 100644 --- a/src/components/memory_manager/test/memory_manager.tests.yaml +++ b/src/components/memory_manager/test/memory_manager.tests.yaml @@ -2,28 +2,28 @@ description: This is a unit test suite for the Memory Manager component tests: - name: Test_Init - description: This unit test excersizes all possible combinations of initializing the component to make sure only valid initializations succeed, and others throw an assertion. + description: This unit test exercises all possible combinations of initializing the component to make sure only valid initializations succeed, and others throw an assertion. - name: Test_Nominal_Request_Release - description: This unit test excersizes the nominal request/release of the component's memory region. + description: This unit test exercises the nominal request/release of the component's memory region. - name: Test_Off_Nominal_Request_Release - description: This unit test excersizes the error conditions that can arise when requesting/releasing the component's memory region. + description: This unit test exercises the error conditions that can arise when requesting/releasing the component's memory region. - name: Test_Nominal_Memory_Dump - description: This unit test excersizes the memory dump commands. + description: This unit test exercises the memory dump commands. - name: Test_Nominal_Memory_Crc - description: This unit test excersizes the memory crc commands. + description: This unit test exercises the memory crc commands. - name: Test_Nominal_Memory_Write - description: This unit test excersizes the memory write command. + description: This unit test exercises the memory write command. - name: Test_Write_Unreleased_Region - description: This unit test excersizes the write command when the memory is not available. + description: This unit test exercises the write command when the memory is not available. - name: Test_Dump_Invalid_Region - description: This unit test excersizes the memory dump command with invalid memory regions. + description: This unit test exercises the memory dump command with invalid memory regions. - name: Test_Crc_Invalid_Region - description: This unit test excersizes the crc command with invalid memory regions. + description: This unit test exercises the crc command with invalid memory regions. - name: Test_Write_Invalid_Region - description: This unit test excersizes the write command with invalid memory regions. + description: This unit test exercises the write command with invalid memory regions. - name: Test_Force_Release_Command - description: This unit test excersizes the force release command. + description: This unit test exercises the force release command. - name: Test_Command_Dropped - description: This unit test excersizes the behavior when the internal queue overflows. + description: This unit test exercises the behavior when the internal queue overflows. - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. diff --git a/src/components/memory_manager/test/memory_manager_tests-implementation.ads b/src/components/memory_manager/test/memory_manager_tests-implementation.ads index a479bded..69962616 100644 --- a/src/components/memory_manager/test/memory_manager_tests-implementation.ads +++ b/src/components/memory_manager/test/memory_manager_tests-implementation.ads @@ -11,29 +11,29 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes all possible combinations of initializing the component to make sure only valid initializations succeed, and others throw an assertion. + -- This unit test exercises all possible combinations of initializing the component to make sure only valid initializations succeed, and others throw an assertion. overriding procedure Test_Init (Self : in out Instance); - -- This unit test excersizes the nominal request/release of the component's memory region. + -- This unit test exercises the nominal request/release of the component's memory region. overriding procedure Test_Nominal_Request_Release (Self : in out Instance); - -- This unit test excersizes the error conditions that can arise when requesting/releasing the component's memory region. + -- This unit test exercises the error conditions that can arise when requesting/releasing the component's memory region. overriding procedure Test_Off_Nominal_Request_Release (Self : in out Instance); - -- This unit test excersizes the memory dump commands. + -- This unit test exercises the memory dump commands. overriding procedure Test_Nominal_Memory_Dump (Self : in out Instance); - -- This unit test excersizes the memory crc commands. + -- This unit test exercises the memory crc commands. overriding procedure Test_Nominal_Memory_Crc (Self : in out Instance); - -- This unit test excersizes the memory write command. + -- This unit test exercises the memory write command. overriding procedure Test_Nominal_Memory_Write (Self : in out Instance); - -- This unit test excersizes the write command when the memory is not available. + -- This unit test exercises the write command when the memory is not available. overriding procedure Test_Write_Unreleased_Region (Self : in out Instance); - -- This unit test excersizes the memory dump command with invalid memory regions. + -- This unit test exercises the memory dump command with invalid memory regions. overriding procedure Test_Dump_Invalid_Region (Self : in out Instance); - -- This unit test excersizes the crc command with invalid memory regions. + -- This unit test exercises the crc command with invalid memory regions. overriding procedure Test_Crc_Invalid_Region (Self : in out Instance); - -- This unit test excersizes the write command with invalid memory regions. + -- This unit test exercises the write command with invalid memory regions. overriding procedure Test_Write_Invalid_Region (Self : in out Instance); - -- This unit test excersizes the force release command. + -- This unit test exercises the force release command. overriding procedure Test_Force_Release_Command (Self : in out Instance); - -- This unit test excersizes the behavior when the internal queue overflows. + -- This unit test exercises the behavior when the internal queue overflows. overriding procedure Test_Command_Dropped (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); diff --git a/src/components/memory_manager/types/memory_manager_enums.enums.yaml b/src/components/memory_manager/types/memory_manager_enums.enums.yaml index 50580d65..fa5bc76a 100644 --- a/src/components/memory_manager/types/memory_manager_enums.enums.yaml +++ b/src/components/memory_manager/types/memory_manager_enums.enums.yaml @@ -9,7 +9,7 @@ enums: description: The memory region is available for request. - name: In_Use value: 1 - description: The memory region is NOT available for request, as it is currently in use by another requestor. + description: The memory region is NOT available for request, as it is currently in use by another requester. - name: Memory_Request_Status description: This status relates whether or not the memory request succeeded or failed. literals: diff --git a/src/components/memory_packetizer/test/memory_packetizer.tests.yaml b/src/components/memory_packetizer/test/memory_packetizer.tests.yaml index 8f65512e..67fb6706 100644 --- a/src/components/memory_packetizer/test/memory_packetizer.tests.yaml +++ b/src/components/memory_packetizer/test/memory_packetizer.tests.yaml @@ -4,9 +4,9 @@ tests: - name: Test_Nominal_Packetization description: This unit test tests the packetizer's normal behavior and make sure it packetizes memory properly, metering out the packets according to its rate. - name: Test_Set_Max_Packet_Rate - description: This unit test tests the Set_Max_Packet_Rate commmand, and ensures that the rate changes appropriately. + description: This unit test tests the Set_Max_Packet_Rate command, and ensures that the rate changes appropriately. - name: Test_Invalid_Command - description: This unit test tests a bad Set_Max_Packet_Rate commmand, and ensures that an appropriate event is thrown. + description: This unit test tests a bad Set_Max_Packet_Rate command, and ensures that an appropriate event is thrown. - name: Test_Memory_Dump_Dropped description: This unit test tests the behavior when the component's queue becomes full and must drop a memory dump request. - name: Test_Max_Packet_Id_Exceeded diff --git a/src/components/memory_packetizer/test/memory_packetizer_tests-implementation.ads b/src/components/memory_packetizer/test/memory_packetizer_tests-implementation.ads index b09701f5..f95141dc 100644 --- a/src/components/memory_packetizer/test/memory_packetizer_tests-implementation.ads +++ b/src/components/memory_packetizer/test/memory_packetizer_tests-implementation.ads @@ -13,9 +13,9 @@ private -- This unit test tests the packetizer's normal behavior and make sure it packetizes memory properly, metering out the packets according to its rate. overriding procedure Test_Nominal_Packetization (Self : in out Instance); - -- This unit test tests the Set_Max_Packet_Rate commmand, and ensures that the rate changes appropriately. + -- This unit test tests the Set_Max_Packet_Rate command, and ensures that the rate changes appropriately. overriding procedure Test_Set_Max_Packet_Rate (Self : in out Instance); - -- This unit test tests a bad Set_Max_Packet_Rate commmand, and ensures that an appropriate event is thrown. + -- This unit test tests a bad Set_Max_Packet_Rate command, and ensures that an appropriate event is thrown. overriding procedure Test_Invalid_Command (Self : in out Instance); -- This unit test tests the behavior when the component's queue becomes full and must drop a memory dump request. overriding procedure Test_Memory_Dump_Dropped (Self : in out Instance); diff --git a/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id.tests.yaml b/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id.tests.yaml index 4f9742f6..d049a3f0 100644 --- a/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id.tests.yaml +++ b/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id.tests.yaml @@ -4,8 +4,8 @@ tests: - name: Test_Nominal_Packetization description: This unit test tests the packetizer's normal behavior and make sure it packetizes memory properly, metering out the packets according to its rate. - name: Test_Set_Max_Packet_Rate - description: This unit test tests the Set_Max_Packet_Rate commmand, and ensures that the rate changes appropriately. + description: This unit test tests the Set_Max_Packet_Rate command, and ensures that the rate changes appropriately. - name: Test_Invalid_Command - description: This unit test tests a bad Set_Max_Packet_Rate commmand, and ensures that an appropriate event is thrown. + description: This unit test tests a bad Set_Max_Packet_Rate command, and ensures that an appropriate event is thrown. - name: Test_Memory_Dump_Dropped description: This unit test tests the behavior when the component's queue becomes full and must drop a memory dump request. diff --git a/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id_tests-implementation.ads b/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id_tests-implementation.ads index e3298eee..9cce04d6 100644 --- a/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id_tests-implementation.ads +++ b/src/components/memory_packetizer_fixed_id/test/memory_packetizer_fixed_id_tests-implementation.ads @@ -14,9 +14,9 @@ private -- This unit test tests the packetizer's normal behavior and make sure it packetizes memory properly, metering out the packets according to its rate. overriding procedure Test_Nominal_Packetization (Self : in out Instance); - -- This unit test tests the Set_Max_Packet_Rate commmand, and ensures that the rate changes appropriately. + -- This unit test tests the Set_Max_Packet_Rate command, and ensures that the rate changes appropriately. overriding procedure Test_Set_Max_Packet_Rate (Self : in out Instance); - -- This unit test tests a bad Set_Max_Packet_Rate commmand, and ensures that an appropriate event is thrown. + -- This unit test tests a bad Set_Max_Packet_Rate command, and ensures that an appropriate event is thrown. overriding procedure Test_Invalid_Command (Self : in out Instance); -- This unit test tests the behavior when the component's queue becomes full and must drop a memory dump request. overriding procedure Test_Memory_Dump_Dropped (Self : in out Instance); diff --git a/src/components/memory_stuffer/component-memory_stuffer-implementation.adb b/src/components/memory_stuffer/component-memory_stuffer-implementation.adb index 7a362d1f..2ea9a96d 100644 --- a/src/components/memory_stuffer/component-memory_stuffer-implementation.adb +++ b/src/components/memory_stuffer/component-memory_stuffer-implementation.adb @@ -70,7 +70,7 @@ package body Component.Memory_Stuffer.Implementation is end case; end Tick_T_Recv_Async; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/memory_stuffer/component-memory_stuffer-implementation.ads b/src/components/memory_stuffer/component-memory_stuffer-implementation.ads index 5aebf645..0653031b 100644 --- a/src/components/memory_stuffer/component-memory_stuffer-implementation.ads +++ b/src/components/memory_stuffer/component-memory_stuffer-implementation.ads @@ -55,7 +55,7 @@ private overriding procedure Tick_T_Recv_Async (Self : in out Instance; Arg : in Tick.T); -- This procedure is called when a Tick_T_Recv_Async message is dropped due to a full queue. overriding procedure Tick_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Tick.T) is null; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T) is null; diff --git a/src/components/memory_stuffer/memory_stuffer.component.yaml b/src/components/memory_stuffer/memory_stuffer.component.yaml index 88f2cee8..09dc7ccc 100644 --- a/src/components/memory_stuffer/memory_stuffer.component.yaml +++ b/src/components/memory_stuffer/memory_stuffer.component.yaml @@ -16,13 +16,13 @@ connectors: - description: This tick is used to keep track of the armed state timeout and send the data product relating the current timeout value. type: Tick.T kind: recv_async - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: A memory region is received on this connector and stuffed to a different memory region, a memory copy. type: Memory_Region_Copy.T kind: recv_async - - description: This connector is used to release the received memory region after a copy has occured. + - description: This connector is used to release the received memory region after a copy has occurred. type: Memory_Region_Release.T kind: send - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.adb b/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.adb index bcfed851..cf6d3671 100644 --- a/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.adb +++ b/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.adb @@ -85,7 +85,7 @@ package body Component.Memory_Stuffer.Implementation.Tester is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This connector is used to release the received memory region after a copy has occured. + -- This connector is used to release the received memory region after a copy has occurred. overriding procedure Memory_Region_Release_T_Recv_Sync (Self : in out Instance; Arg : in Memory_Region_Release.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.ads b/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.ads index b0df6a83..e06a47cc 100644 --- a/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.ads +++ b/src/components/memory_stuffer/test/component-memory_stuffer-implementation-tester.ads @@ -96,7 +96,7 @@ package Component.Memory_Stuffer.Implementation.Tester is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This connector is used to release the received memory region after a copy has occured. + -- This connector is used to release the received memory region after a copy has occurred. overriding procedure Memory_Region_Release_T_Recv_Sync (Self : in out Instance; Arg : in Memory_Region_Release.T); -- This connector is used to register and respond to the component's commands. overriding procedure Command_Response_T_Recv_Sync (Self : in out Instance; Arg : in Command_Response.T); diff --git a/src/components/memory_stuffer/test/memory_stuffer.tests.yaml b/src/components/memory_stuffer/test/memory_stuffer.tests.yaml index 5cf1f7e6..1ae33006 100644 --- a/src/components/memory_stuffer/test/memory_stuffer.tests.yaml +++ b/src/components/memory_stuffer/test/memory_stuffer.tests.yaml @@ -4,18 +4,18 @@ tests: - name: Test_Invalid_Initialization description: This unit test makes sure that an invalid initialization results in a runtime assertion. - name: Test_Unprotected_Stuffing - description: This unit test excersizes stuffing a region that is unprotected. + description: This unit test exercises stuffing a region that is unprotected. - name: Test_Protected_Stuffing - description: This unit test excersizes stuffing a region that is protected. + description: This unit test exercises stuffing a region that is protected. - name: Test_Arm_Unarm - description: This unit test excersizes all of the ways that the arm command can be invalidated prior to a write (except via timeout). + description: This unit test exercises all of the ways that the arm command can be invalidated prior to a write (except via timeout). - name: Test_Arm_Timeout - description: This unit test excersizes the unarming of the arm command via timeout. + description: This unit test exercises the unarming of the arm command via timeout. - name: Test_Invalid_Address - description: This unit test excersizes writing to an invalid region of memory + description: This unit test exercises writing to an invalid region of memory - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. - name: Test_Memory_Region_Copy - description: This unit test excersizes the memory region copy and release connectors. + description: This unit test exercises the memory region copy and release connectors. - name: Test_Memory_Region_Copy_Invalid_Address - description: This unit test excersizes the memory region copy and release connectors with an invalid destination address. + description: This unit test exercises the memory region copy and release connectors with an invalid destination address. diff --git a/src/components/memory_stuffer/test/memory_stuffer_tests-implementation.ads b/src/components/memory_stuffer/test/memory_stuffer_tests-implementation.ads index b75cb0e9..319c489f 100644 --- a/src/components/memory_stuffer/test/memory_stuffer_tests-implementation.ads +++ b/src/components/memory_stuffer/test/memory_stuffer_tests-implementation.ads @@ -13,21 +13,21 @@ private -- This unit test makes sure that an invalid initialization results in a runtime assertion. overriding procedure Test_Invalid_Initialization (Self : in out Instance); - -- This unit test excersizes stuffing a region that is unprotected. + -- This unit test exercises stuffing a region that is unprotected. overriding procedure Test_Unprotected_Stuffing (Self : in out Instance); - -- This unit test excersizes stuffing a region that is protected. + -- This unit test exercises stuffing a region that is protected. overriding procedure Test_Protected_Stuffing (Self : in out Instance); - -- This unit test excersizes all of the ways that the arm command can be invalidated prior to a write (except via timeout). + -- This unit test exercises all of the ways that the arm command can be invalidated prior to a write (except via timeout). overriding procedure Test_Arm_Unarm (Self : in out Instance); - -- This unit test excersizes the unarming of the arm command via timeout. + -- This unit test exercises the unarming of the arm command via timeout. overriding procedure Test_Arm_Timeout (Self : in out Instance); - -- This unit test excersizes writing to an invalid region of memory + -- This unit test exercises writing to an invalid region of memory overriding procedure Test_Invalid_Address (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); - -- This unit test excersizes the memory region copy and release connectors. + -- This unit test exercises the memory region copy and release connectors. overriding procedure Test_Memory_Region_Copy (Self : in out Instance); - -- This unit test excersizes the memory region copy and release connectors with an invalid destination address. + -- This unit test exercises the memory region copy and release connectors with an invalid destination address. overriding procedure Test_Memory_Region_Copy_Invalid_Address (Self : in out Instance); -- Test data and state: diff --git a/src/components/parameter_store/component-parameter_store-implementation.adb b/src/components/parameter_store/component-parameter_store-implementation.adb index 144d142f..6bacd983 100644 --- a/src/components/parameter_store/component-parameter_store-implementation.adb +++ b/src/components/parameter_store/component-parameter_store-implementation.adb @@ -56,7 +56,7 @@ package body Component.Parameter_Store.Implementation is if Self.Is_Packet_T_Send_Connected then -- First calculate the CRC of the parameter store, and overwrite the calculated_CRC field in the header. -- We do this every time we dump the packet, to make sure the calculated_CRC is always up to date. This - -- lets the ground see if a bit flip ocurred. + -- lets the ground see if a bit flip occurred. declare use Serializer_Types; use Basic_Types; @@ -79,7 +79,7 @@ package body Component.Parameter_Store.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/parameter_store/component-parameter_store-implementation.ads b/src/components/parameter_store/component-parameter_store-implementation.ads index dc409db4..379ae23a 100644 --- a/src/components/parameter_store/component-parameter_store-implementation.ads +++ b/src/components/parameter_store/component-parameter_store-implementation.ads @@ -48,7 +48,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); diff --git a/src/components/parameter_store/parameter_store.component.yaml b/src/components/parameter_store/parameter_store.component.yaml index 294c12f6..242ee072 100644 --- a/src/components/parameter_store/parameter_store.component.yaml +++ b/src/components/parameter_store/parameter_store.component.yaml @@ -13,7 +13,7 @@ init: description: If set to True, the component will dump the current parameter values any time a memory region is received to change the parameter table. If set to False, parameters will only be dumped when requested by command. default: "False" connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: This connector is used to send command responses. diff --git a/src/components/parameters/component-parameters-implementation.adb b/src/components/parameters/component-parameters-implementation.adb index ae682b2e..b59c525e 100644 --- a/src/components/parameters/component-parameters-implementation.adb +++ b/src/components/parameters/component-parameters-implementation.adb @@ -59,7 +59,7 @@ package body Component.Parameters.Implementation is -- Make sure the parameter entries are layout in byte order, with no deadspace and no overlap, and are not too large. pragma Assert (Param_Entry.Start_Index = Current_Byte, "Unexpected byte layout in parameter table at ID '" & Parameter_Id'Image (Param_Entry.Id) & "'."); - pragma Assert (Param_Entry.End_Index >= Param_Entry.Start_Index, "end_Index must be greated than start_Index at ID '" & Parameter_Id'Image (Param_Entry.Id) & "'."); + pragma Assert (Param_Entry.End_Index >= Param_Entry.Start_Index, "end_Index must be greater than start_Index at ID '" & Parameter_Id'Image (Param_Entry.Id) & "'."); pragma Assert (Param_Entry.End_Index - Param_Entry.Start_Index + 1 <= Parameter_Types.Parameter_Buffer_Length_Type'Last, "Parameter ID '" & Parameter_Id'Image (Param_Entry.Id) & "' is too large to fit in the parameter record."); Current_Byte := Param_Entry.End_Index + 1; @@ -394,7 +394,7 @@ package body Component.Parameters.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/parameters/component-parameters-implementation.ads b/src/components/parameters/component-parameters-implementation.ads index 1f809965..c3f97e28 100644 --- a/src/components/parameters/component-parameters-implementation.ads +++ b/src/components/parameters/component-parameters-implementation.ads @@ -51,7 +51,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); diff --git a/src/components/parameters/gen/doc/parameter_table_generator.tex b/src/components/parameters/gen/doc/parameter_table_generator.tex index d91297a2..8e3fdd54 100644 --- a/src/components/parameters/gen/doc/parameter_table_generator.tex +++ b/src/components/parameters/gen/doc/parameter_table_generator.tex @@ -21,7 +21,7 @@ \section{Schema} \section{Example Input} -The following is an example parameter tabl input yaml file. Model files must be named in the form \textit{optional\_name.assembly\_name.parameter\_table.yaml} where \textit{optional\_name} is the specific name of the parameter table and is only necessary if there is more than one Parameters component instance in an assembly. The \textit{assembly\_name} is the assembly which this table will be used, and the rest of the model file name must remain as shown. Generally this file is created in the same directory or near to the assembly model file. This example adheres to the schema shown in the previous section, and is commented to give clarification. +The following is an example parameter table input yaml file. Model files must be named in the form \textit{optional\_name.assembly\_name.parameter\_table.yaml} where \textit{optional\_name} is the specific name of the parameter table and is only necessary if there is more than one Parameters component instance in an assembly. The \textit{assembly\_name} is the assembly which this table will be used, and the rest of the model file name must remain as shown. Generally this file is created in the same directory or near to the assembly model file. This example adheres to the schema shown in the previous section, and is commented to give clarification. \yamlcodef{../../test/test_assembly/test_parameter_table.test_assembly.parameter_table.yaml} diff --git a/src/components/parameters/gen/models/parameters_packets.py b/src/components/parameters/gen/models/parameters_packets.py index 5bfb632f..2c13d774 100644 --- a/src/components/parameters/gen/models/parameters_packets.py +++ b/src/components/parameters/gen/models/parameters_packets.py @@ -6,7 +6,7 @@ # This model is a specialized packet suite for the Parameters packet. This # class inherits from the normal packets model but adds some extra functionality -# needed to the parameters packet. In particular, the parmaeters packet's +# needed to the parameters packet. In particular, the parameters packet's # type is derived from data within the assembly that the packet is a part of. The # type itself gets filled in in the "load_assembly" method. class parameters_packets(packets): diff --git a/src/components/parameters/gen/schemas/parameter_table.yaml b/src/components/parameters/gen/schemas/parameter_table.yaml index 49c386ef..b0321af1 100644 --- a/src/components/parameters/gen/schemas/parameter_table.yaml +++ b/src/components/parameters/gen/schemas/parameter_table.yaml @@ -17,7 +17,7 @@ mapping: parameters: seq: # Each parameter name must be in the format "Component_Instance_Name"."Parameter_Name" or - # simpy "Component_Instance_Name" to use all of the component's parameters. + # simply "Component_Instance_Name" to use all of the component's parameters. - type: str required: False # A parameter table must have at least one parameter. diff --git a/src/components/parameters/parameters.component.yaml b/src/components/parameters/parameters.component.yaml index 9b77583f..297016fb 100644 --- a/src/components/parameters/parameters.component.yaml +++ b/src/components/parameters/parameters.component.yaml @@ -17,7 +17,7 @@ connectors: type: Parameter_Update.T kind: provide count: 0 - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: This connector is used to send command responses. diff --git a/src/components/pid_controller/component-pid_controller-implementation.adb b/src/components/pid_controller/component-pid_controller-implementation.adb index bc4b4521..72ccd608 100644 --- a/src/components/pid_controller/component-pid_controller-implementation.adb +++ b/src/components/pid_controller/component-pid_controller-implementation.adb @@ -225,7 +225,7 @@ package body Component.Pid_Controller.Implementation is Self.Process_Parameter_Update (Arg); end Parameter_Update_T_Modify; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/pid_controller/component-pid_controller-implementation.ads b/src/components/pid_controller/component-pid_controller-implementation.ads index cd786938..cb8538bb 100644 --- a/src/components/pid_controller/component-pid_controller-implementation.ads +++ b/src/components/pid_controller/component-pid_controller-implementation.ads @@ -87,7 +87,7 @@ private overriding procedure Control_Input_U_Recv_Sync (Self : in out Instance; Arg : in Control_Input.U); -- The parameter update connector. This does not need to be connected if the parameter for this component will not be used. overriding procedure Parameter_Update_T_Modify (Self : in out Instance; Arg : in out Parameter_Update.T); - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T); --------------------------------------- diff --git a/src/components/pid_controller/pid_controller.component.yaml b/src/components/pid_controller/pid_controller.component.yaml index a5ee52f8..ed5a1f4a 100644 --- a/src/components/pid_controller/pid_controller.component.yaml +++ b/src/components/pid_controller/pid_controller.component.yaml @@ -34,7 +34,7 @@ connectors: - description: Packet for sending diagnostic packets. type: Packet.T kind: send - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/pid_controller/pid_controller.parameters.yaml b/src/components/pid_controller/pid_controller.parameters.yaml index d4194415..a55b536a 100644 --- a/src/components/pid_controller/pid_controller.parameters.yaml +++ b/src/components/pid_controller/pid_controller.parameters.yaml @@ -18,10 +18,10 @@ parameters: type: Packed_F32.T default: "(Value => 0.0)" - name: i_Min_Limit - description: The minimum (negative direction) integral windup limit used in the PID controller. If the integrator goes below this limit then the integrator is capped at this limit. This prevents runaway integral windup in the negative direction. The negative and positive limits are separated to allow configuration of asymetrical windup limits, which might be needed for control systems that cannot control in both directions, ie. a heater controller. + description: The minimum (negative direction) integral windup limit used in the PID controller. If the integrator goes below this limit then the integrator is capped at this limit. This prevents runaway integral windup in the negative direction. The negative and positive limits are separated to allow configuration of asymmetrical windup limits, which might be needed for control systems that cannot control in both directions, ie. a heater controller. type: Packed_F32.T default: "(Value => -1.0 * Short_Float'Large)" - name: i_Max_Limit - description: The maximum (positive direction) integral windup limit used in the PID controller. If the integrator goes above this limit then the integrator is capped at this limit. This prevents runaway integral windup in the positive direction. The negative and positive limits are separated to allow configuration of asymetrical windup limits, which might be needed for control systems that cannot control in both directions, ie. a heater controller. + description: The maximum (positive direction) integral windup limit used in the PID controller. If the integrator goes above this limit then the integrator is capped at this limit. This prevents runaway integral windup in the positive direction. The negative and positive limits are separated to allow configuration of asymmetrical windup limits, which might be needed for control systems that cannot control in both directions, ie. a heater controller. type: Packed_F32.T default: "(Value => Short_Float'Large)" diff --git a/src/components/pid_controller/pid_controller.requirements.yaml b/src/components/pid_controller/pid_controller.requirements.yaml index 01b5fb8f..27a782a6 100644 --- a/src/components/pid_controller/pid_controller.requirements.yaml +++ b/src/components/pid_controller/pid_controller.requirements.yaml @@ -4,6 +4,6 @@ requirements: - text: The PID controller component shall take a measured error input to determine the P, I, and D components of the control. - text: The PID controller component shall include a limit to the integral term to avoid controller wind-up. - text: The PID controller component shall include a feed-forward term to the controller. - - text: The PID controller component shall calculate the mean, variance, and max of the error over a specifed sample count. + - text: The PID controller component shall calculate the mean, variance, and max of the error over a specified sample count. - text: The PID controller component shall produce diagnostic packets with subpackets that contain the measured, reference, and the current angle. - text: The PID controller component shall output the current control error for control of hardware by other components. diff --git a/src/components/pid_controller/test/pid_controller_tests-implementation.adb b/src/components/pid_controller/test/pid_controller_tests-implementation.adb index 7ee20c15..ee0ba775 100644 --- a/src/components/pid_controller/test/pid_controller_tests-implementation.adb +++ b/src/components/pid_controller/test/pid_controller_tests-implementation.adb @@ -258,7 +258,7 @@ package body Pid_Controller_Tests.Implementation is Packed_F32_Assert.Eq (T.Pid_Error_History.Get (2), (Value => 4.0)); Short_Float_Assert.Eq (T.Control_Output_U_Recv_Sync_History.Get (4).Output_Value, 48.794, Epsilon => 0.001); - -- Now lets test the limiting on the integral term in the negitive direction + -- Now lets test the limiting on the integral term in the negative direction T.Control_Input_U_Send (((0, 0), 10.0, 1.0, 0.0, True)); T.Control_Input_U_Send (((0, 0), 10.0, 1.0, 0.0, False)); T.Control_Input_U_Send (((0, 0), 10.0, 1.0, 0.0, False)); diff --git a/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.adb b/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.adb index c4b3ff92..e49de4d3 100644 --- a/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.adb +++ b/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.adb @@ -54,7 +54,7 @@ package body Component.Precision_Time_Protocol_Master.Implementation is -- Transaction_Number data product is defined as the last sent sequence number. Self.Transaction_Count := Self.Transaction_Count + 1; - -- Send out sync messsage: + -- Send out sync message: Self.Ptp_Time_Message_T_Send ((Message_Type => Sync, Transaction_Count => Self.Transaction_Count, Time_Stamp => Time_Stamp)); -- Update data products: @@ -131,7 +131,7 @@ package body Component.Precision_Time_Protocol_Master.Implementation is overriding procedure Follow_Up_Sys_Time_T_Recv_Async (Self : in out Instance; Arg : in Sys_Time.T) is use Ptp_Enums.Ptp_Message_Type; begin - -- Send out follow up messsage with updated time: + -- Send out follow up message with updated time: Self.Ptp_Time_Message_T_Send ((Message_Type => Follow_Up, Transaction_Count => Self.Transaction_Count, Time_Stamp => Arg)); -- Update data products: diff --git a/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.ads b/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.ads index 94ea1b93..803bbf90 100644 --- a/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.ads +++ b/src/components/precision_time_protocol_master/component-precision_time_protocol_master-implementation.ads @@ -34,7 +34,7 @@ private Sync_Period : Positive := Positive'First; -- Boolean to allow us to sync once: Sync_Once : Boolean := False; - -- Counters for keeping track of messages sent and recieved + -- Counters for keeping track of messages sent and received -- by PTP master. Transaction_Count : Interfaces.Unsigned_16 := Interfaces.Unsigned_16'First; Follow_Up_Message_Count : Interfaces.Unsigned_16 := Interfaces.Unsigned_16'First; diff --git a/src/components/precision_time_protocol_master/precision_time_protocol_master.events.yaml b/src/components/precision_time_protocol_master/precision_time_protocol_master.events.yaml index ff305d95..5196ce42 100644 --- a/src/components/precision_time_protocol_master/precision_time_protocol_master.events.yaml +++ b/src/components/precision_time_protocol_master/precision_time_protocol_master.events.yaml @@ -2,10 +2,10 @@ description: Events for the Precision Time Protocol Master component. events: - name: Unexpected_Message_Type - description: Recieved a message of unexpected type, message is sent as parameter. + description: Received a message of unexpected type, message is sent as parameter. param_type: Ptp_Time_Message.T - name: Unexpected_Transaction_Count - description: Recieved a message of unexpected type, message is sent as parameter along with the expected transaction number. + description: Received a message of unexpected type, message is sent as parameter along with the expected transaction number. param_type: Unexpected_Ptp_Transaction_Count.T - name: Ptp_Enabled description: The PTP has been enabled by command. diff --git a/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.adb b/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.adb index ec49ad12..61af16f6 100644 --- a/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.adb +++ b/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.adb @@ -183,14 +183,14 @@ package body Component.Precision_Time_Protocol_Master.Implementation.Tester is ----------------------------------------------- -- Description: -- Events for the Precision Time Protocol Master component. - -- Recieved a message of unexpected type, message is sent as parameter. + -- Received a message of unexpected type, message is sent as parameter. overriding procedure Unexpected_Message_Type (Self : in out Instance; Arg : in Ptp_Time_Message.T) is begin -- Push the argument onto the test history for looking at later: Self.Unexpected_Message_Type_History.Push (Arg); end Unexpected_Message_Type; - -- Recieved a message of unexpected type, message is sent as parameter along with the expected transaction number. + -- Received a message of unexpected type, message is sent as parameter along with the expected transaction number. overriding procedure Unexpected_Transaction_Count (Self : in out Instance; Arg : in Unexpected_Ptp_Transaction_Count.T) is begin -- Push the argument onto the test history for looking at later: diff --git a/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.ads b/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.ads index dbcd9921..cf1fc5d0 100644 --- a/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.ads +++ b/src/components/precision_time_protocol_master/test/component-precision_time_protocol_master-implementation-tester.ads @@ -126,9 +126,9 @@ package Component.Precision_Time_Protocol_Master.Implementation.Tester is ----------------------------------------------- -- Description: -- Events for the Precision Time Protocol Master component. - -- Recieved a message of unexpected type, message is sent as parameter. + -- Received a message of unexpected type, message is sent as parameter. overriding procedure Unexpected_Message_Type (Self : in out Instance; Arg : in Ptp_Time_Message.T); - -- Recieved a message of unexpected type, message is sent as parameter along with the expected transaction number. + -- Received a message of unexpected type, message is sent as parameter along with the expected transaction number. overriding procedure Unexpected_Transaction_Count (Self : in out Instance; Arg : in Unexpected_Ptp_Transaction_Count.T); -- PTP been enabled by command. overriding procedure Ptp_Enabled (Self : in out Instance); diff --git a/src/components/precision_time_protocol_master/types/ptp_time_message_receive.record.yaml b/src/components/precision_time_protocol_master/types/ptp_time_message_receive.record.yaml index 676a2774..3f80d035 100644 --- a/src/components/precision_time_protocol_master/types/ptp_time_message_receive.record.yaml +++ b/src/components/precision_time_protocol_master/types/ptp_time_message_receive.record.yaml @@ -1,5 +1,5 @@ --- -description: Record for the PTP Time Sync Message. This record includes a a time stamp which signifies when the message was received by the system. If the timestamp is set to zero, then time is retreived at the receipt of this message by the component. +description: Record for the PTP Time Sync Message. This record includes a a time stamp which signifies when the message was received by the system. If the timestamp is set to zero, then time is retrieved at the receipt of this message by the component. fields: - name: Receive_Time description: The time when the PTP message was received by the system. If this is set to zeros, then the component will grab a timestamp when receiving this message and assume that as the received time. diff --git a/src/components/product_database/component-product_database-implementation.ads b/src/components/product_database/component-product_database-implementation.ads index 2fabc831..e3223307 100644 --- a/src/components/product_database/component-product_database-implementation.ads +++ b/src/components/product_database/component-product_database-implementation.ads @@ -10,7 +10,7 @@ with Command; with Variable_Database; with Basic_Enums; --- The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minumum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs recieved during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID iself as a direct index into the database. +-- The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minimum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs received during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID itself as a direct index into the database. -- -- Note that IDs stored in this database should come from a compact ID space for most efficient memory usage. If you are manually setting the data product ID bases in your assembly model and creating a sparse ID set than this database component should not be used, as it could waste an enormous amount of memory. This component is designed to work best with the default, Adamant-allocated ID space for data products which spans from 1 to number of data products used in the system. package Component.Product_Database.Implementation is diff --git a/src/components/product_database/product_database.component.yaml b/src/components/product_database/product_database.component.yaml index c55c9553..89547bd9 100644 --- a/src/components/product_database/product_database.component.yaml +++ b/src/components/product_database/product_database.component.yaml @@ -1,6 +1,6 @@ --- description: | - The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minumum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs recieved during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID iself as a direct index into the database. + The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minimum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs received during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID itself as a direct index into the database. Note that IDs stored in this database should come from a compact ID space for most efficient memory usage. If you are manually setting the data product ID bases in your assembly model and creating a sparse ID set than this database component should not be used, as it could waste an enormous amount of memory. This component is designed to work best with the default, Adamant-allocated ID space for data products which spans from 1 to number of data products used in the system. execution: passive diff --git a/src/components/product_database/test/component-product_database-implementation-tester.ads b/src/components/product_database/test/component-product_database-implementation-tester.ads index 90773dd9..2ec302fc 100644 --- a/src/components/product_database/test/component-product_database-implementation-tester.ads +++ b/src/components/product_database/test/component-product_database-implementation-tester.ads @@ -21,7 +21,7 @@ with Data_Product_Poly_Extract.Representation; with Data_Product_Poly_Event.Representation; with Invalid_Command_Info.Representation; --- The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minumum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs recieved during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID iself as a direct index into the database. +-- The product database component maintains a database of data product items. Only the latest single copy of each data product item is stored, and that value can be updated or fetched by ID via connectors. The component is configured by passing the minimum and maximum data product ID that the database can accept. The component allocates memory on the heap to store a maximum sized data product for every ID in range from the minimum to maximum ID provided. Invalid IDs received during requests are reported as events. The lookup algorithm is extremely fast, using the data product ID itself as a direct index into the database. -- -- Note that IDs stored in this database should come from a compact ID space for most efficient memory usage. If you are manually setting the data product ID bases in your assembly model and creating a sparse ID set than this database component should not be used, as it could waste an enormous amount of memory. This component is designed to work best with the default, Adamant-allocated ID space for data products which spans from 1 to number of data products used in the system. package Component.Product_Database.Implementation.Tester is diff --git a/src/components/product_packetizer/component-product_packetizer-implementation.adb b/src/components/product_packetizer/component-product_packetizer-implementation.adb index d5049357..da1a7d15 100644 --- a/src/components/product_packetizer/component-product_packetizer-implementation.adb +++ b/src/components/product_packetizer/component-product_packetizer-implementation.adb @@ -27,7 +27,7 @@ package body Component.Product_Packetizer.Implementation is -- Find a common multiple for the packet periods. We do this to make sure -- that periods are upheld even in the case of rollover of the counter value. for Idx in Self.Packet_List.all'Range loop - -- Make sure all packet items are not null in Init, so we don't get a suprise later. + -- Make sure all packet items are not null in Init, so we don't get a surprise later. pragma Assert (Self.Packet_List.all (Idx).Items /= null); -- Extract the period from this index: diff --git a/src/components/product_packetizer/test/tests-implementation.ads b/src/components/product_packetizer/test/tests-implementation.ads index a49cefcf..9fd3a5d8 100644 --- a/src/components/product_packetizer/test/tests-implementation.ads +++ b/src/components/product_packetizer/test/tests-implementation.ads @@ -37,7 +37,7 @@ private overriding procedure Test_Zero_Period (Self : in out Instance); -- This unit test tests a command being dropped due to a full queue. overriding procedure Test_Full_Queue (Self : in out Instance); - -- This unit test tests the special packet period items that can be emmitted inside an product packetizer packet. + -- This unit test tests the special packet period items that can be emitted inside an product packetizer packet. overriding procedure Test_Packet_Period_Items (Self : in out Instance); -- Test data and state: diff --git a/src/components/product_packetizer/test/tests.product_packetizer.tests.yaml b/src/components/product_packetizer/test/tests.product_packetizer.tests.yaml index c0cef52d..8de5e800 100644 --- a/src/components/product_packetizer/test/tests.product_packetizer.tests.yaml +++ b/src/components/product_packetizer/test/tests.product_packetizer.tests.yaml @@ -28,4 +28,4 @@ tests: - name: Test_Full_Queue description: This unit test tests a command being dropped due to a full queue. - name: Test_Packet_Period_Items - description: This unit test tests the special packet period items that can be emmitted inside an product packetizer packet. This unit test also tests a special packet period item with a bad ID. + description: This unit test tests the special packet period items that can be emitted inside an product packetizer packet. This unit test also tests a special packet period item with a bad ID. diff --git a/src/components/queue_monitor/component-queue_monitor-implementation.adb b/src/components/queue_monitor/component-queue_monitor-implementation.adb index 41c3c74c..3d8f50b8 100644 --- a/src/components/queue_monitor/component-queue_monitor-implementation.adb +++ b/src/components/queue_monitor/component-queue_monitor-implementation.adb @@ -76,7 +76,7 @@ package body Component.Queue_Monitor.Implementation is Self.Packet_Counter.Increment_Count; end Tick_T_Recv_Sync; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/queue_monitor/component-queue_monitor-implementation.ads b/src/components/queue_monitor/component-queue_monitor-implementation.ads index 322f1abe..e2a0055e 100644 --- a/src/components/queue_monitor/component-queue_monitor-implementation.ads +++ b/src/components/queue_monitor/component-queue_monitor-implementation.ads @@ -52,7 +52,7 @@ private --------------------------------------- -- This is the base tick for the component. overriding procedure Tick_T_Recv_Sync (Self : in out Instance; Arg : in Tick.T); - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T); --------------------------------------- diff --git a/src/components/queue_monitor/queue_monitor.component.yaml b/src/components/queue_monitor/queue_monitor.component.yaml index 33ae50b8..10e28cc2 100644 --- a/src/components/queue_monitor/queue_monitor.component.yaml +++ b/src/components/queue_monitor/queue_monitor.component.yaml @@ -22,7 +22,7 @@ connectors: - description: The system time is retrieved via this connector. return_type: Sys_Time.T kind: get - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/queue_monitor/test/queue_monitor.tests.yaml b/src/components/queue_monitor/test/queue_monitor.tests.yaml index 0c2b6acb..c1eb7065 100644 --- a/src/components/queue_monitor/test/queue_monitor.tests.yaml +++ b/src/components/queue_monitor/test/queue_monitor.tests.yaml @@ -2,8 +2,8 @@ description: This is a unit test suite for the Queue Monitor component. tests: - name: Test_Queue_Monitoring - description: This unit test excersizes checking a component's queue reporting the values in telemetry. + description: This unit test exercises checking a component's queue reporting the values in telemetry. - name: Test_Packet_Period - description: This unit test excersizes the command to change the packet creation rate. + description: This unit test exercises the command to change the packet creation rate. - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. diff --git a/src/components/queue_monitor/test/queue_monitor_tests-implementation.ads b/src/components/queue_monitor/test/queue_monitor_tests-implementation.ads index dc45034f..baef2c53 100644 --- a/src/components/queue_monitor/test/queue_monitor_tests-implementation.ads +++ b/src/components/queue_monitor/test/queue_monitor_tests-implementation.ads @@ -11,9 +11,9 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes checking a component's queue reporting the values in telemetry. + -- This unit test exercises checking a component's queue reporting the values in telemetry. overriding procedure Test_Queue_Monitoring (Self : in out Instance); - -- This unit test excersizes the command to change the packet creation rate. + -- This unit test exercises the command to change the packet creation rate. overriding procedure Test_Packet_Period (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); diff --git a/src/components/rate_group/component-rate_group-implementation.adb b/src/components/rate_group/component-rate_group-implementation.adb index 19a3f09f..306c7866 100644 --- a/src/components/rate_group/component-rate_group-implementation.adb +++ b/src/components/rate_group/component-rate_group-implementation.adb @@ -16,7 +16,7 @@ package body Component.Rate_Group.Implementation is -- -- Init Parameters: -- Ticks_Per_Timing_Report : Interfaces.Unsigned_16 - The period (in ticks) that the component should wait before sending a timing report data product. A value of zero prevents the component from sending the data product. - -- Timing_Report_Delay_Ticks : Interfaces.Unsigned_16 - The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desireable to ignore these cycles in the timing report, especially for the maximum values. + -- Timing_Report_Delay_Ticks : Interfaces.Unsigned_16 - The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desirable to ignore these cycles in the timing report, especially for the maximum values. -- Issue_Time_Exceeded_Events : Boolean - If set to True, an event will be issued any time the maximum execution or wall clock time of the component is exceeded. If set to False, these events will never be issued. The same information is accessible via the component's data products, so enabling the event may become a redundant annoyance. -- overriding procedure Init (Self : in out Instance; Ticks_Per_Timing_Report : in Interfaces.Unsigned_16 := 1; Timing_Report_Delay_Ticks : in Interfaces.Unsigned_16 := 3; Issue_Time_Exceeded_Events : in Boolean := False) is diff --git a/src/components/rate_group/component-rate_group-implementation.ads b/src/components/rate_group/component-rate_group-implementation.ads index 756382e8..21cc07a7 100644 --- a/src/components/rate_group/component-rate_group-implementation.ads +++ b/src/components/rate_group/component-rate_group-implementation.ads @@ -5,7 +5,7 @@ -- Standard Includes: with Ada.Real_Time; use Ada.Real_Time; --- The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all excute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. +-- The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all execute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. -- -- Note that this component is designed to be Active in an assembly. In this way the Rate Group will provide a task on which Passive components can execute. -- @@ -20,7 +20,7 @@ package Component.Rate_Group.Implementation is -- -- Init Parameters: -- Ticks_Per_Timing_Report : Interfaces.Unsigned_16 - The period (in ticks) that the component should wait before sending a timing report data product. A value of zero prevents the component from sending the data product. - -- Timing_Report_Delay_Ticks : Interfaces.Unsigned_16 - The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desireable to ignore these cycles in the timing report, especially for the maximum values. + -- Timing_Report_Delay_Ticks : Interfaces.Unsigned_16 - The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desirable to ignore these cycles in the timing report, especially for the maximum values. -- Issue_Time_Exceeded_Events : Boolean - If set to True, an event will be issued any time the maximum execution or wall clock time of the component is exceeded. If set to False, these events will never be issued. The same information is accessible via the component's data products, so enabling the event may become a redundant annoyance. -- overriding procedure Init (Self : in out Instance; Ticks_Per_Timing_Report : in Interfaces.Unsigned_16 := 1; Timing_Report_Delay_Ticks : in Interfaces.Unsigned_16 := 3; Issue_Time_Exceeded_Events : in Boolean := False); diff --git a/src/components/rate_group/event_args/cycle_slip_param.record.yaml b/src/components/rate_group/event_args/cycle_slip_param.record.yaml index 027b24a0..fe7759d7 100644 --- a/src/components/rate_group/event_args/cycle_slip_param.record.yaml +++ b/src/components/rate_group/event_args/cycle_slip_param.record.yaml @@ -2,9 +2,9 @@ description: This is a type that contains useful information about a cycle slip. fields: - name: Slipped_Tick - description: "The tick during which the cycle slip occured." + description: "The tick during which the cycle slip occurred." type: Tick.T - name: Num_Slips - description: "The number of cycle slips that have occured." + description: "The number of cycle slips that have occurred." type: Interfaces.Unsigned_16 format: U16 diff --git a/src/components/rate_group/rate_group.component.yaml b/src/components/rate_group/rate_group.component.yaml index 08a60096..253266bf 100644 --- a/src/components/rate_group/rate_group.component.yaml +++ b/src/components/rate_group/rate_group.component.yaml @@ -1,6 +1,6 @@ --- description: | - The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all excute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. The component also includes a connector to service (ie. ``pet") a downstream software watchdog during each execution cycle. This connection is optional and may be left unconnected if not used. + The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all execute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. The component also includes a connector to service (ie. ``pet") a downstream software watchdog during each execution cycle. This connection is optional and may be left unconnected if not used. Note that this component is designed to be Active in an assembly. In this way the Rate Group will provide a task on which Passive components can execute. execution: active @@ -15,7 +15,7 @@ init: - name: Timing_Report_Delay_Ticks type: Interfaces.Unsigned_16 default: '3' - description: The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desireable to ignore these cycles in the timing report, especially for the maximum values. + description: The number of tickes the component waits before calculating and sending a timing report data product. It is common for the first few executions of a rate group to have execution times longer than normal due to startup logic. In this case, it is often desirable to ignore these cycles in the timing report, especially for the maximum values. - name: Issue_Time_Exceeded_Events type: Boolean default: 'False' diff --git a/src/components/rate_group/test/component-rate_group-implementation-tester.ads b/src/components/rate_group/test/component-rate_group-implementation-tester.ads index 24b49500..f9261216 100644 --- a/src/components/rate_group/test/component-rate_group-implementation-tester.ads +++ b/src/components/rate_group/test/component-rate_group-implementation-tester.ads @@ -18,7 +18,7 @@ with Cycle_Slip_Param.Representation; with Time_Exceeded.Representation; with Full_Queue_Param.Representation; --- The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all excute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. +-- The Rate Group component is a queued component which invokes Tick connectors attached to it whenever it receives a Tick in. The tick in is intended to be periodic, allowing the component to control the execution of other components at a periodic rate. All components attached to the invoker connector of this component are said to be in a rate group, since they all execute at the same rate. Components are executed in the order they are attached to the components invoker connector. The execution of all attached connectors is expected to complete before another incoming Tick is put on the Rate Group component's queue. If the execution runs long, a cycle slip event is reported. -- -- Note that this component is designed to be Active in an assembly. In this way the Rate Group will provide a task on which Passive components can execute. package Component.Rate_Group.Implementation.Tester is diff --git a/src/components/rate_group/test/tests-implementation.adb b/src/components/rate_group/test/tests-implementation.adb index 01aa8ad0..cc49b8e2 100644 --- a/src/components/rate_group/test/tests-implementation.adb +++ b/src/components/rate_group/test/tests-implementation.adb @@ -174,7 +174,7 @@ package body Tests.Implementation is -- -------------------------------------------------- -- -- For this test change the time delta so more - -- -- elapsed time occures during execution. This + -- -- elapsed time occurs during execution. This -- -- should trigger the mex execution time. The -- -- tick time is set high enough that a new -- -- cycle time should not be thrown: diff --git a/src/components/rate_group/test/tests-implementation.ads b/src/components/rate_group/test/tests-implementation.ads index 0e5962d5..2f856016 100644 --- a/src/components/rate_group/test/tests-implementation.ads +++ b/src/components/rate_group/test/tests-implementation.ads @@ -11,7 +11,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes Rate Group component through a nominal scenario. + -- This unit test exercises Rate Group component through a nominal scenario. overriding procedure Nominal (Self : in out Instance); -- This unit test triggers a cycle slip and makes sure that the Rate Group component reports it. overriding procedure Cycle_Slip_Trigger (Self : in out Instance); diff --git a/src/components/rate_group/test/tests.rate_group.tests.yaml b/src/components/rate_group/test/tests.rate_group.tests.yaml index 0a617f4c..44b6e22d 100644 --- a/src/components/rate_group/test/tests.rate_group.tests.yaml +++ b/src/components/rate_group/test/tests.rate_group.tests.yaml @@ -2,7 +2,7 @@ description: This is a unit test suite for the Rate Group component. tests: - name: Nominal - description: This unit test excersizes Rate Group component through a nominal scenario. + description: This unit test exercises Rate Group component through a nominal scenario. - name: Cycle_Slip_Trigger description: This unit test triggers a cycle slip and makes sure that the Rate Group component reports it. - name: Time_Reporting diff --git a/src/components/sequence_store/component-sequence_store-implementation.adb b/src/components/sequence_store/component-sequence_store-implementation.adb index de4f6803..a1209a47 100644 --- a/src/components/sequence_store/component-sequence_store-implementation.adb +++ b/src/components/sequence_store/component-sequence_store-implementation.adb @@ -17,7 +17,7 @@ package body Component.Sequence_Store.Implementation is use Sequence_Store_Types; - -- Define the overhead byte assciated with a slot in memory. + -- Define the overhead byte associated with a slot in memory. Num_Slot_Meta_Bytes : constant Natural := Sequence_Store_Slot_Header.Size_In_Bytes - Sequence_Header.Size_In_Bytes; -- Check our constant to make sure it makes sense. pragma Compile_Time_Error (Num_Slot_Meta_Bytes /= Sequence_Store_Slot_Metadata.Size_In_Bytes, "Expected meta data bytes to equal size of metadata type."); @@ -122,7 +122,7 @@ package body Component.Sequence_Store.Implementation is -- function does not check the bounds of the slot_Index, it assumes that the caller -- has already checked the bounds. function Get_Slot_Header (Self : in Instance; Slot_Index : in Slot_Number) return Sequence_Store_Slot_Header.T is - -- Overlay sequence header over the begining of the appropriate slot. We know that this overlay + -- Overlay sequence header over the beginning of the appropriate slot. We know that this overlay -- will not go over the end of the memory region, since we have checked the memory region's length -- in the Init, and ensured they are all at least as large as this header. To_Return : constant Sequence_Store_Slot_Header.T with Import, Convention => Ada, Address => Self.Slots.all (Slot_Index).Address; @@ -134,7 +134,7 @@ package body Component.Sequence_Store.Implementation is -- function does not check the bounds of the slot_Index, it assumes that the caller -- has already checked the bounds. procedure Set_Slot_Header (Self : in Instance; Slot_Index : in Slot_Number; Header : in Sequence_Store_Slot_Header.T) is - -- Overlay sequence header over the begining of the appropriate slot. We know that this overlay + -- Overlay sequence header over the beginning of the appropriate slot. We know that this overlay -- will not go over the end of the memory region, since we have checked the memory region's length -- in the Init, and ensured they are all at least as large as this header. To_Set : Sequence_Store_Slot_Header.T with Import, Convention => Ada, Address => Self.Slots.all (Slot_Index).Address; @@ -145,7 +145,7 @@ package body Component.Sequence_Store.Implementation is -- Given a slot number return the memory region that stores the sequence header and sequence data. This memory -- region excludes the slot meta data which is found at the beginning of each slot. function Get_Sequence_Memory_Region (Self : in Instance; Slot_Index : in Slot_Number) return Memory_Region.T is - -- Overlay sequence header over the begining of the appropriate slot. We know that this overlay + -- Overlay sequence header over the beginning of the appropriate slot. We know that this overlay -- will not go over the end of the memory region, since we have checked the memory region's length -- in the Init, and ensured they are all at least as large as this header. Slot_Header : constant Sequence_Store_Slot_Header.T with Import, Convention => Ada, Address => Self.Slots.all (Slot_Index).Address; @@ -158,7 +158,7 @@ package body Component.Sequence_Store.Implementation is -- Given a slot number return the maximum sized memory region that could store a sequence header and sequence data at this slot. -- This memory region excludes the slot meta data which is found at the beginning of each slot. function Get_Max_Size_Sequence_Memory_Region (Self : in Instance; Slot_Index : in Slot_Number) return Memory_Region.T is - -- Overlay sequence header over the begining of the appropriate slot. We know that this overlay + -- Overlay sequence header over the beginning of the appropriate slot. We know that this overlay -- will not go over the end of the memory region, since we have checked the memory region's length -- in the Init, and ensured they are all at least as large as this header. Slot_Header : constant Sequence_Store_Slot_Header.T with Import, Convention => Ada, Address => Self.Slots.all (Slot_Index).Address; @@ -302,7 +302,7 @@ package body Component.Sequence_Store.Implementation is B_Stop : constant System.Address := B.Address + Storage_Offset (B.Length - 1); -- Calculate offset between start addresses. Note: that there is no -- > or < operators supplied for System.Address, so we use subtraction - -- instead to convert the offset to a Storage_Offset wich supports these + -- instead to convert the offset to a Storage_Offset which supports these -- comparison operators. Offset : constant Storage_Offset := A_Start - B_Start; begin @@ -394,7 +394,7 @@ package body Component.Sequence_Store.Implementation is --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); @@ -596,7 +596,7 @@ package body Component.Sequence_Store.Implementation is end if; end Activate_Slot; - -- Deactive a sequence slot so that its contents can no longer be fetched. + -- Deactivate a sequence slot so that its contents can no longer be fetched. overriding function Deactivate_Slot (Self : in out Instance; Arg : in Packed_Slot_Number.T) return Command_Execution_Status.E is use Command_Execution_Status; use Sequence_Store_Enums.Slot_State_Type; diff --git a/src/components/sequence_store/component-sequence_store-implementation.ads b/src/components/sequence_store/component-sequence_store-implementation.ads index b7ae6842..c8b15a0d 100644 --- a/src/components/sequence_store/component-sequence_store-implementation.ads +++ b/src/components/sequence_store/component-sequence_store-implementation.ads @@ -98,7 +98,7 @@ private --------------------------------------- -- Invokee connector primitives: --------------------------------------- - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Async (Self : in out Instance; Arg : in Command.T); -- This procedure is called when a Command_T_Recv_Async message is dropped due to a full queue. overriding procedure Command_T_Recv_Async_Dropped (Self : in out Instance; Arg : in Command.T); @@ -128,7 +128,7 @@ private -- These are the commands for the Parameter Store component. -- Activate a sequence slot so that its contents can be fetched. overriding function Activate_Slot (Self : in out Instance; Arg : in Packed_Slot_Number.T) return Command_Execution_Status.E; - -- Deactive a sequence slot so that its contents can no longer be fetched. + -- Deactivate a sequence slot so that its contents can no longer be fetched. overriding function Deactivate_Slot (Self : in out Instance; Arg : in Packed_Slot_Number.T) return Command_Execution_Status.E; -- Check the CRC of a sequence in a particular slot to see if it matches the CRC found in the header. overriding function Check_Slot (Self : in out Instance; Arg : in Packed_Slot_Number.T) return Command_Execution_Status.E; diff --git a/src/components/sequence_store/sequence_store.commands.yaml b/src/components/sequence_store/sequence_store.commands.yaml index 76e5a172..986b28c5 100644 --- a/src/components/sequence_store/sequence_store.commands.yaml +++ b/src/components/sequence_store/sequence_store.commands.yaml @@ -5,7 +5,7 @@ commands: description: Activate a sequence slot so that its contents can be fetched. arg_type: Packed_Slot_Number.T - name: Deactivate_Slot - description: Deactive a sequence slot so that its contents can no longer be fetched. + description: Deactivate a sequence slot so that its contents can no longer be fetched. arg_type: Packed_Slot_Number.T - name: Check_Slot description: Check the CRC of a sequence in a particular slot to see if it matches the CRC found in the header. diff --git a/src/components/sequence_store/sequence_store.component.yaml b/src/components/sequence_store/sequence_store.component.yaml index c09ea580..83350b52 100644 --- a/src/components/sequence_store/sequence_store.component.yaml +++ b/src/components/sequence_store/sequence_store.component.yaml @@ -23,7 +23,7 @@ init: type: Boolean description: "If True, then the slot summaries will be dumped at startup." connectors: - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_async - description: This connector is used to send command responses. diff --git a/src/components/sequence_store/test/sequence_store_tests-implementation.adb b/src/components/sequence_store/test/sequence_store_tests-implementation.adb index 94a7fbc8..9f24ec11 100644 --- a/src/components/sequence_store/test/sequence_store_tests-implementation.adb +++ b/src/components/sequence_store/test/sequence_store_tests-implementation.adb @@ -736,7 +736,7 @@ package body Sequence_Store_Tests.Implementation is Natural_Assert.Eq (T.Dumping_Slot_Summary_History.Get_Count, 4); Natural_Assert.Eq (T.Dumped_Slot_Summary_History.Get_Count, 4); - -- Send command to check nonexistant slot: + -- Send command to check nonexistent slot: T.Command_T_Send (T.Commands.Check_Slot ((Slot => 4))); Natural_Assert.Eq (T.Dispatch_All, 1); Natural_Assert.Eq (T.Command_Response_T_Recv_Sync_History.Get_Count, 5); diff --git a/src/components/stack_monitor/component-stack_monitor-implementation.adb b/src/components/stack_monitor/component-stack_monitor-implementation.adb index bb512c2b..d1c8b635 100644 --- a/src/components/stack_monitor/component-stack_monitor-implementation.adb +++ b/src/components/stack_monitor/component-stack_monitor-implementation.adb @@ -186,7 +186,7 @@ package body Component.Stack_Monitor.Implementation is Self.Counter.Increment_Count; end Tick_T_Recv_Sync; - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is -- Execute the command: Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg); diff --git a/src/components/stack_monitor/component-stack_monitor-implementation.ads b/src/components/stack_monitor/component-stack_monitor-implementation.ads index ff2d4d70..769f3df9 100644 --- a/src/components/stack_monitor/component-stack_monitor-implementation.ads +++ b/src/components/stack_monitor/component-stack_monitor-implementation.ads @@ -61,7 +61,7 @@ private --------------------------------------- -- This is the base tick for the component. overriding procedure Tick_T_Recv_Sync (Self : in out Instance; Arg : in Tick.T); - -- This is the command recieve connector. + -- This is the command receive connector. overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T); --------------------------------------- diff --git a/src/components/stack_monitor/stack_monitor.component.yaml b/src/components/stack_monitor/stack_monitor.component.yaml index 0b35b17f..c6f9a13d 100644 --- a/src/components/stack_monitor/stack_monitor.component.yaml +++ b/src/components/stack_monitor/stack_monitor.component.yaml @@ -22,7 +22,7 @@ connectors: - description: The system time is retrieved via this connector. return_type: Sys_Time.T kind: get - - description: This is the command recieve connector. + - description: This is the command receive connector. type: Command.T kind: recv_sync - description: This connector is used to register and respond to the component's commands. diff --git a/src/components/stack_monitor/test/stack_monitor.tests.yaml b/src/components/stack_monitor/test/stack_monitor.tests.yaml index fd3f0c63..5213fef5 100644 --- a/src/components/stack_monitor/test/stack_monitor.tests.yaml +++ b/src/components/stack_monitor/test/stack_monitor.tests.yaml @@ -2,8 +2,8 @@ description: This is a unit test suite for the Stack Monitor component tests: - name: Test_Stack_Monitoring - description: This unit test excersizes checking a component's stack and secondary stack and reporting the values in telemetry. + description: This unit test exercises checking a component's stack and secondary stack and reporting the values in telemetry. - name: Test_Packet_Period - description: This unit test excersizes the command to change the packet creation rate. + description: This unit test exercises the command to change the packet creation rate. - name: Test_Invalid_Command description: This unit test makes sure an invalid command is reported and ignored. diff --git a/src/components/stack_monitor/test/stack_monitor_tests-implementation.adb b/src/components/stack_monitor/test/stack_monitor_tests-implementation.adb index f6e37f7d..bd1cbfa2 100644 --- a/src/components/stack_monitor/test/stack_monitor_tests-implementation.adb +++ b/src/components/stack_monitor/test/stack_monitor_tests-implementation.adb @@ -153,12 +153,12 @@ package body Stack_Monitor_Tests.Implementation is -- Test the primary stack. Let's fill up the stacks 639 bytes and see what happens. for Idx in Natural range 0 .. 638 loop - Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other thatn 0xCC - Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other thatn 0xCC + Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other than 0xCC + Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other than 0xCC end loop; -- A little white box testing. The internal index in the component for - -- cacheing should be the last possible index. + -- caching should be the last possible index. T.Check_Stack_Indexes ((Task_1_Stack'Last, Task_2_Stack'Last)); -- Send a tick and expect a packet. @@ -174,14 +174,14 @@ package body Stack_Monitor_Tests.Implementation is -- Test the primary stack. Let's fill up the first stack to 90 percent and -- the second stack to 50 percent. for Idx in Natural range 639 .. 902 loop - Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other thatn 0xCC + Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other than 0xCC end loop; for Idx in Natural range 639 .. 1_002 loop - Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other thatn 0xCC + Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other than 0xCC end loop; -- A little white box testing. The internal index in the component for - -- cacheing should be at the last location where the stack ended. + -- caching should be at the last location where the stack ended. T.Check_Stack_Indexes ((Task_1_Stack'Last - 638, Task_2_Stack'Last - 638)); -- Send a tick and expect a packet. @@ -196,14 +196,14 @@ package body Stack_Monitor_Tests.Implementation is -- Test the primary stack. Let's fill up the stacks to 100 percent. for Idx in Natural range 902 .. 999 loop - Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other thatn 0xCC + Task_1_Stack (Task_1_Stack'Last - Idx) := 12; -- Something other than 0xCC end loop; for Idx in Natural range 1_002 .. 1_999 loop - Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other thatn 0xCC + Task_2_Stack (Task_2_Stack'Last - Idx) := 12; -- Something other than 0xCC end loop; -- A little white box testing. The internal index in the component for - -- cacheing should be at the last location where the stack ended. + -- caching should be at the last location where the stack ended. T.Check_Stack_Indexes ((Task_1_Stack'Last - 902, Task_2_Stack'Last - 1_002)); -- Send a tick and expect a packet. @@ -217,7 +217,7 @@ package body Stack_Monitor_Tests.Implementation is Packet_Assert.Eq (T.Packet_T_Recv_Sync_History.Get (8), Pkt); -- A little white box testing. The internal index in the component for - -- cacheing should be at the last location where the stack ended. + -- caching should be at the last location where the stack ended. T.Check_Stack_Indexes ((0, 0)); -- Send a tick and expect a packet. @@ -229,7 +229,7 @@ package body Stack_Monitor_Tests.Implementation is Packet_Assert.Eq (T.Packet_T_Recv_Sync_History.Get (9), Pkt); -- A little white box testing. The internal index in the component for - -- cacheing should be at the last location where the stack ended. + -- caching should be at the last location where the stack ended. T.Check_Stack_Indexes ((0, 0)); -- OK let's test some special cases. @@ -247,7 +247,7 @@ package body Stack_Monitor_Tests.Implementation is Packet_Assert.Eq (T.Packet_T_Recv_Sync_History.Get (10), Pkt); -- A little white box testing. The internal index in the component for - -- cacheing should be at the last location where the stack ended. + -- caching should be at the last location where the stack ended. T.Check_Stack_Indexes ((0, 0)); -- No events should have been sent unless a command was sent. No commands were sent. diff --git a/src/components/stack_monitor/test/stack_monitor_tests-implementation.ads b/src/components/stack_monitor/test/stack_monitor_tests-implementation.ads index 2e5e1905..c6b639b7 100644 --- a/src/components/stack_monitor/test/stack_monitor_tests-implementation.ads +++ b/src/components/stack_monitor/test/stack_monitor_tests-implementation.ads @@ -11,9 +11,9 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes checking a component's stack and secondary stack and reporting the values in telemetry. + -- This unit test exercises checking a component's stack and secondary stack and reporting the values in telemetry. overriding procedure Test_Stack_Monitoring (Self : in out Instance); - -- This unit test excersizes the command to change the packet creation rate. + -- This unit test exercises the command to change the packet creation rate. overriding procedure Test_Packet_Period (Self : in out Instance); -- This unit test makes sure an invalid command is reported and ignored. overriding procedure Test_Invalid_Command (Self : in out Instance); diff --git a/src/components/task_watchdog/task_watchdog.component.yaml b/src/components/task_watchdog/task_watchdog.component.yaml index 28df238d..33ef4637 100644 --- a/src/components/task_watchdog/task_watchdog.component.yaml +++ b/src/components/task_watchdog/task_watchdog.component.yaml @@ -1,6 +1,6 @@ --- description: | - The Task Watchdog component receives pets from components that execute in a periodic manner throughout the assembly. The receipt of a pet indicates that the component is running well and is what is refered to as a watchdog. If it detects that the component has stopped executing for some configurable time, called a limit, it will either ignore the fault, throw a warning event, or throw a fault and possibly stop servicing an downstream watchdog (usually a hardware watchdog) based on the component's configuration. The configuration is dependent on the input list generated from a yaml model for this component. The input requires a connector name, a limit for the number of ticks without a pet, the criticality of the component, and the action to take if the limit is exceeded which is one of the three described before. + The Task Watchdog component receives pets from components that execute in a periodic manner throughout the assembly. The receipt of a pet indicates that the component is running well and is what is referred to as a watchdog. If it detects that the component has stopped executing for some configurable time, called a limit, it will either ignore the fault, throw a warning event, or throw a fault and possibly stop servicing an downstream watchdog (usually a hardware watchdog) based on the component's configuration. The configuration is dependent on the input list generated from a yaml model for this component. The input requires a connector name, a limit for the number of ticks without a pet, the criticality of the component, and the action to take if the limit is exceeded which is one of the three described before. In addition, the criticality of the task is also defined in the yaml model which determines if the watchdog component stops petting the downstream watchdog. execution: passive init: diff --git a/src/components/task_watchdog/task_watchdog.events.yaml b/src/components/task_watchdog/task_watchdog.events.yaml index 78f17ca6..dea09960 100644 --- a/src/components/task_watchdog/task_watchdog.events.yaml +++ b/src/components/task_watchdog/task_watchdog.events.yaml @@ -1,9 +1,9 @@ --- events: - name: Watchdog_Pet_Checks_Enabled - description: Indicates a command was recieved to enable the checks on upstream pets. + description: Indicates a command was received to enable the checks on upstream pets. - name: Watchdog_Pet_Checks_Disabled - description: Indicates a command was recieved to disable the checks on upstream pets. + description: Indicates a command was received to disable the checks on upstream pets. - name: Watchdog_Limit_Set description: An event to indicate that the limit was changed by command for a particular index. param_type: Watchdog_Limit_Cmd.T diff --git a/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.adb b/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.adb index 7fab6ad5..db5320cb 100644 --- a/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.adb +++ b/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.adb @@ -154,7 +154,7 @@ package body Component.Task_Watchdog.Implementation.Tester is ----------------------------------------------- -- Event handler primitive: ----------------------------------------------- - -- Indicates a command was recieved to enable the checks on upstream pets. + -- Indicates a command was received to enable the checks on upstream pets. overriding procedure Watchdog_Pet_Checks_Enabled (Self : in out Instance) is Arg : constant Natural := 0; begin @@ -162,7 +162,7 @@ package body Component.Task_Watchdog.Implementation.Tester is Self.Watchdog_Pet_Checks_Enabled_History.Push (Arg); end Watchdog_Pet_Checks_Enabled; - -- Indicates a command was recieved to disable the checks on upstream pets. + -- Indicates a command was received to disable the checks on upstream pets. overriding procedure Watchdog_Pet_Checks_Disabled (Self : in out Instance) is Arg : constant Natural := 0; begin diff --git a/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.ads b/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.ads index 2e993489..6aa7803d 100644 --- a/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.ads +++ b/src/components/task_watchdog/test/component-task_watchdog-implementation-tester.ads @@ -23,7 +23,7 @@ with Watchdog_Action_Cmd.Representation; with Packed_Connector_Index.Representation; with Invalid_Command_Info.Representation; --- The Task Watchdog component receives pets from components that execute in a periodic manner throughout the assembly. The receipt of a pet indicates that the component is running well and is what is refered to as a watchdog. If it detects that the component has stopped executing for some configurable time, called a limit, it will either ignore the fault, throw a warning event, or throw a fault and possibly stop servicing an downstream watchdog (usually a hardware watchdog) based on the component's configuration. The configuration is dependent on the input list generated from a yaml model for this component. The input requires a connector name, a limit for the number of ticks without a pet, the criticality of the component, and the action to take if the limit is exceeded which is one of the three described before. +-- The Task Watchdog component receives pets from components that execute in a periodic manner throughout the assembly. The receipt of a pet indicates that the component is running well and is what is referred to as a watchdog. If it detects that the component has stopped executing for some configurable time, called a limit, it will either ignore the fault, throw a warning event, or throw a fault and possibly stop servicing an downstream watchdog (usually a hardware watchdog) based on the component's configuration. The configuration is dependent on the input list generated from a yaml model for this component. The input requires a connector name, a limit for the number of ticks without a pet, the criticality of the component, and the action to take if the limit is exceeded which is one of the three described before. -- In addition, the criticality of the task is also defined in the yaml model which determines if the watchdog component stops petting the downstream watchdog. package Component.Task_Watchdog.Implementation.Tester is @@ -115,9 +115,9 @@ package Component.Task_Watchdog.Implementation.Tester is ----------------------------------------------- -- Event handler primitive: ----------------------------------------------- - -- Indicates a command was recieved to enable the checks on upstream pets. + -- Indicates a command was received to enable the checks on upstream pets. overriding procedure Watchdog_Pet_Checks_Enabled (Self : in out Instance); - -- Indicates a command was recieved to disable the checks on upstream pets. + -- Indicates a command was received to disable the checks on upstream pets. overriding procedure Watchdog_Pet_Checks_Disabled (Self : in out Instance); -- An event to indicate that the limit was changed by command for a particular index. overriding procedure Watchdog_Limit_Set (Self : in out Instance; Arg : in Watchdog_Limit_Cmd.T); diff --git a/src/components/task_watchdog/test/task_watchdog_tests-implementation.adb b/src/components/task_watchdog/test/task_watchdog_tests-implementation.adb index e2f8dc78..692c566d 100644 --- a/src/components/task_watchdog/test/task_watchdog_tests-implementation.adb +++ b/src/components/task_watchdog/test/task_watchdog_tests-implementation.adb @@ -348,7 +348,7 @@ package body Task_Watchdog_Tests.Implementation is T.Pet_T_Send (Connector_Count_Type (2), Input_Pet); T.Pet_T_Send (Connector_Count_Type (3), Input_Pet); - -- First change is to promote to fault on one that is apropriate but was not defined as fault to start + -- First change is to promote to fault on one that is appropriate but was not defined as fault to start T.Command_T_Send (T.Commands.Set_Watchdog_Action ((Index => 3, New_Action => Watchdog_Action_State.Error_Fault))); Natural_Assert.Eq (T.Command_Response_T_Recv_Sync_History.Get_Count, 1); Command_Response_Assert.Eq (T.Command_Response_T_Recv_Sync_History.Get (1), (Source_Id => 0, Registration_Id => 0, Command_Id => T.Commands.Get_Set_Watchdog_Action_Id, Status => Success)); diff --git a/src/components/task_watchdog/types/task_watchdog_types.ads b/src/components/task_watchdog/types/task_watchdog_types.ads index 41a61876..426485f7 100644 --- a/src/components/task_watchdog/types/task_watchdog_types.ads +++ b/src/components/task_watchdog/types/task_watchdog_types.ads @@ -4,7 +4,7 @@ with Task_Watchdog_Enums; package Task_Watchdog_Types is use Task_Watchdog_Enums; - -- Counter types for compatability and limits + -- Counter types for compatibility and limits type Missed_Pet_Count_Type is new Natural range Natural'First .. 65535; subtype Missed_Pet_Limit_Type is Missed_Pet_Count_Type range Missed_Pet_Count_Type'First + 1 .. Missed_Pet_Count_Type'Last - 1; diff --git a/src/components/tick_divider/test/tests-implementation.adb b/src/components/tick_divider/test/tests-implementation.adb index a6e99696..c58a4f2c 100644 --- a/src/components/tick_divider/test/tests-implementation.adb +++ b/src/components/tick_divider/test/tests-implementation.adb @@ -51,7 +51,7 @@ package body Tests.Implementation is T.Tick_T_Send ((Time => Systime, Count => Unsigned_32 (Idx))); end loop; - -- Make sure rollover occured: + -- Make sure rollover occurred: Boolean_Assert.Eq (T.Check_Counts (Count => 5, Max_Count => 70), True); -- We are expecting 74/7 + 74/5 + 2 (for 0th iteration) for diff --git a/src/components/tick_divider/test/tests-implementation.ads b/src/components/tick_divider/test/tests-implementation.ads index 5967060f..28e3ac77 100644 --- a/src/components/tick_divider/test/tests-implementation.ads +++ b/src/components/tick_divider/test/tests-implementation.ads @@ -11,7 +11,7 @@ private overriding procedure Set_Up_Test (Self : in out Instance); overriding procedure Tear_Down_Test (Self : in out Instance); - -- This unit test excersizes tick dividing with a variety of divisors, including disabled divisors. It runs the component through enough iterations to excersize the count rollover, and checks to make sure this happens. + -- This unit test exercises tick dividing with a variety of divisors, including disabled divisors. It runs the component through enough iterations to exercise the count rollover, and checks to make sure this happens. overriding procedure Nominal (Self : in out Instance); -- This unit test configures the component with a variety of bad input parameters and checks to make sure exceptions are thrown as expected. overriding procedure Bad_Setup (Self : in out Instance); diff --git a/src/components/tick_divider/test/tests.tick_divider.tests.yaml b/src/components/tick_divider/test/tests.tick_divider.tests.yaml index 6c78703d..07bfed20 100644 --- a/src/components/tick_divider/test/tests.tick_divider.tests.yaml +++ b/src/components/tick_divider/test/tests.tick_divider.tests.yaml @@ -2,7 +2,7 @@ description: This is a unit test suite for the Tick Divider component. tests: - name: Nominal - description: This unit test exercizes tick dividing with a variety of divisors, including disabled divisors. It runs the component through enough iterations to exercize the count rollover, and checks to make sure this happens. + description: This unit test exercises tick dividing with a variety of divisors, including disabled divisors. It runs the component through enough iterations to exercise the count rollover, and checks to make sure this happens. - name: Bad_Setup description: This unit test configures the component with a variety of bad input parameters and checks to make sure exceptions are thrown as expected. - name: Full_Queue diff --git a/src/components/tick_listener/component-tick_listener-implementation.ads b/src/components/tick_listener/component-tick_listener-implementation.ads index 43eb8081..9defdb14 100644 --- a/src/components/tick_listener/component-tick_listener-implementation.ads +++ b/src/components/tick_listener/component-tick_listener-implementation.ads @@ -7,7 +7,7 @@ with Packed_Natural; with Tick; --- This is the Tick Listener component. It is attached to an tick and provides a connector which will give the caller a count. The count includes the number of times the tick has been received since the last invokation of the connector. This component should be made passive in order to function properly. This component is a useful substitude for the Interrupt Listener component when you want to simulate interrupts with software ticks. +-- This is the Tick Listener component. It is attached to an tick and provides a connector which will give the caller a count. The count includes the number of times the tick has been received since the last invocation of the connector. This component should be made passive in order to function properly. This component is a useful substitute for the Interrupt Listener component when you want to simulate interrupts with software ticks. package Component.Tick_Listener.Implementation is -- The component class instance record: @@ -16,7 +16,7 @@ package Component.Tick_Listener.Implementation is private -- This tick handler simply updates an internal count that a task can query and - -- reset. This is useful for letting a task know that tick has occured without + -- reset. This is useful for letting a task know that tick has occurred without -- blocking the task (as the above handler does). protected type Tick_Counter is -- Function which returns the current count without modifying it: diff --git a/src/components/tick_listener/test/component-tick_listener-implementation-tester.ads b/src/components/tick_listener/test/component-tick_listener-implementation-tester.ads index a20c22eb..8fe8e409 100644 --- a/src/components/tick_listener/test/component-tick_listener-implementation-tester.ads +++ b/src/components/tick_listener/test/component-tick_listener-implementation-tester.ads @@ -5,7 +5,7 @@ -- Standard Includes: with Component.Tick_Listener_Reciprocal; --- This is the Tick Listener component. It is attached to an tick and provides a connector which will give the caller a count. The count includes the number of times the tick has been received since the last invokation of the connector. This component should be made passive in order to function properly. This component is a useful substitude for the Interrupt Listener component when you want to simulate interrupts with software ticks. +-- This is the Tick Listener component. It is attached to an tick and provides a connector which will give the caller a count. The count includes the number of times the tick has been received since the last invocation of the connector. This component should be made passive in order to function properly. This component is a useful substitute for the Interrupt Listener component when you want to simulate interrupts with software ticks. package Component.Tick_Listener.Implementation.Tester is -- Component class instance: diff --git a/src/components/time_at_tone_master/component-time_at_tone_master-implementation.adb b/src/components/time_at_tone_master/component-time_at_tone_master-implementation.adb index efa96a09..a94e27ac 100644 --- a/src/components/time_at_tone_master/component-time_at_tone_master-implementation.adb +++ b/src/components/time_at_tone_master/component-time_at_tone_master-implementation.adb @@ -65,7 +65,7 @@ package body Component.Time_At_Tone_Master.Implementation is Current_Sys_Time : constant Sys_Time.T := Self.Sys_Time_T_Get; -- Calculate the wake up time. We grab Clock as close to grabbing the -- system time as possible. We cannot just use Clock as the system time - -- since getting the system time is mission dependant, and Clock may not + -- since getting the system time is mission dependent, and Clock may not -- be accurate as a system time. Clock is a good monotonic time, however, -- so is useful for determining the delay time. Wake_Up_Time : constant Ada.Real_Time.Time := Ada.Real_Time.Clock + Self.Wait_Time; diff --git a/src/components/time_at_tone_master/test/time_at_tone_master_tests-implementation.adb b/src/components/time_at_tone_master/test/time_at_tone_master_tests-implementation.adb index b2d04f9d..ac76138b 100644 --- a/src/components/time_at_tone_master/test/time_at_tone_master_tests-implementation.adb +++ b/src/components/time_at_tone_master/test/time_at_tone_master_tests-implementation.adb @@ -129,7 +129,7 @@ package body Time_At_Tone_Master_Tests.Implementation is Natural_Assert.Eq (T.Tone_Message_Recv_Sync_History.Get_Count, 0); end loop; - -- Set period to one and reenable: + -- Set period to one and re-enable: Self.Tester.Component_Instance.Init (Wait_Time_Ms => 5, Sync_Period => 1, Enabled_State => Disabled); -- Call the component set up method that the assembly would normally call. diff --git a/src/components/time_at_tone_master/types/tat_time_message.record.yaml b/src/components/time_at_tone_master/types/tat_time_message.record.yaml index c9aeeb11..c6f3cca8 100644 --- a/src/components/time_at_tone_master/types/tat_time_message.record.yaml +++ b/src/components/time_at_tone_master/types/tat_time_message.record.yaml @@ -1,10 +1,10 @@ --- -description: The Time message datatype used for sending time messages between the time at tone master and the time at tone slave. Included in this type is the Time when the tone message will be sent and a transation number. +description: The Time message datatype used for sending time messages between the time at tone master and the time at tone slave. Included in this type is the Time when the tone message will be sent and a transaction number. fields: - name: Time description: The timestamp associated with the tick. type: Sys_Time.T - name: Count - description: The transaction number of the message. One transation is a time message and a tone message, increments after the tone message is sent. Can be checked by the time at tone slave to make sure that transactions are not mixed up. + description: The transaction number of the message. One transaction is a time message and a tone message, increments after the tone message is sent. Can be checked by the time at tone slave to make sure that transactions are not mixed up. type: Interfaces.Unsigned_32 format: U32 diff --git a/src/components/time_at_tone_master/types/tat_tone_message.record.yaml b/src/components/time_at_tone_master/types/tat_tone_message.record.yaml index 2950c202..656884da 100644 --- a/src/components/time_at_tone_master/types/tat_tone_message.record.yaml +++ b/src/components/time_at_tone_master/types/tat_tone_message.record.yaml @@ -5,6 +5,6 @@ fields: description: The timestamp associated with the tick. type: Sys_Time.T - name: Count - description: The transaction number of the message. One transation is a time message and a tone message, increments after the tone message is sent. Can be checked by the time at tone slave to make sure that transactions are not mixed up. + description: The transaction number of the message. One transaction is a time message and a tone message, increments after the tone message is sent. Can be checked by the time at tone slave to make sure that transactions are not mixed up. type: Interfaces.Unsigned_32 format: U32 diff --git a/src/components/time_of_tone_master/test/time_of_tone_master_tests-implementation.adb b/src/components/time_of_tone_master/test/time_of_tone_master_tests-implementation.adb index afbbc25e..300e5aec 100644 --- a/src/components/time_of_tone_master/test/time_of_tone_master_tests-implementation.adb +++ b/src/components/time_of_tone_master/test/time_of_tone_master_tests-implementation.adb @@ -159,7 +159,7 @@ package body Time_Of_Tone_Master_Tests.Implementation is Natural_Assert.Eq (T.Tone_Message_Recv_Sync_History.Get_Count, 0); end loop; - -- Set period to one and reenable: + -- Set period to one and re-enable: Self.Tester.Component_Instance.Init (Sync_Period => 1, Enabled_State => Disabled); -- Call the component set up method that the assembly would normally call. diff --git a/src/components/zero_divider/component-zero_divider-implementation.ads b/src/components/zero_divider/component-zero_divider-implementation.ads index 7b5bcf48..7ae0f1a1 100644 --- a/src/components/zero_divider/component-zero_divider-implementation.ads +++ b/src/components/zero_divider/component-zero_divider-implementation.ads @@ -5,7 +5,7 @@ -- Includes: with Command; --- The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertant execution of this command. +-- The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertent execution of this command. package Component.Zero_Divider.Implementation is -- The component class instance record: diff --git a/src/components/zero_divider/test/component-zero_divider-implementation-tester.ads b/src/components/zero_divider/test/component-zero_divider-implementation-tester.ads index 6fdcb8a1..efff941c 100644 --- a/src/components/zero_divider/test/component-zero_divider-implementation-tester.ads +++ b/src/components/zero_divider/test/component-zero_divider-implementation-tester.ads @@ -14,7 +14,7 @@ with Packed_U32.Representation; with Invalid_Command_Info.Representation; with Packed_Exception_Occurrence.Representation; --- The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertant execution of this command. This component also supplies the packet definition for the assembly for a Last Chance Handler (LCH) packet that is created by the last chance handler itself (which is not usually implemented as an Adamant component). This provides the ground system the LCH packet definition so it can be parsed and stored. The component does not contain a Packet.T send connector, so will not send out this packet itself. You Last Chance Handler should produce a packet with this packet definition. +-- The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertent execution of this command. This component also supplies the packet definition for the assembly for a Last Chance Handler (LCH) packet that is created by the last chance handler itself (which is not usually implemented as an Adamant component). This provides the ground system the LCH packet definition so it can be parsed and stored. The component does not contain a Packet.T send connector, so will not send out this packet itself. You Last Chance Handler should produce a packet with this packet definition. package Component.Zero_Divider.Implementation.Tester is use Component.Zero_Divider_Reciprocal; diff --git a/src/components/zero_divider/zero_divider.component.yaml b/src/components/zero_divider/zero_divider.component.yaml index adee6cf6..d19de874 100644 --- a/src/components/zero_divider/zero_divider.component.yaml +++ b/src/components/zero_divider/zero_divider.component.yaml @@ -1,5 +1,5 @@ --- -description: The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertant execution of this command. This component also supplies the packet definition for the assembly for a Last Chance Handler (LCH) packet that is created by the last chance handler itself (which is not usually implemented as an Adamant component). This provides the ground system the LCH packet definition so it can be parsed and stored. The component does not contain a Packet.T send connector, so will not send out this packet itself. You Last Chance Handler should produce a packet with this packet definition. +description: The purpose of this component is to provide a safe, commandable way to cause the Ada Last Chance Handler to be called. To accomplish this, this component provides a Divide_By_Zero command which divides an integer by zero, which causes an Ada exception to be thrown, which is purposely not handled. The Divide_By_Zero command must be passed a magic number as an argument. If the magic number does not match the number that this component is instantiated with at initialization, then the Divide_By_Zero is not executed. This feature prevents inadvertent execution of this command. This component also supplies the packet definition for the assembly for a Last Chance Handler (LCH) packet that is created by the last chance handler itself (which is not usually implemented as an Adamant component). This provides the ground system the LCH packet definition so it can be parsed and stored. The component does not contain a Packet.T send connector, so will not send out this packet itself. You Last Chance Handler should produce a packet with this packet definition. execution: passive preamble: | subtype Magic_Number_Type is Interfaces.Unsigned_32 range 2 .. Interfaces.Unsigned_32'Last; diff --git a/src/core/interrupt_handlers/interrupt_handlers.ads b/src/core/interrupt_handlers/interrupt_handlers.ads index 1f6c5b34..e31cf695 100644 --- a/src/core/interrupt_handlers/interrupt_handlers.ads +++ b/src/core/interrupt_handlers/interrupt_handlers.ads @@ -54,7 +54,7 @@ package Interrupt_Handlers is end Task_Signal; -- This interrupt handler simply updates an internal count that a task can query and - -- reset. This is useful for letting a task know that an interrupt has occured without + -- reset. This is useful for letting a task know that an interrupt has occurred without -- blocking the task (as the above handler does). protected type Interrupt_Counter (Pri : System.Interrupt_Priority; Int_Id : Ada.Interrupts.Interrupt_ID; Custom_Procedure : Interrupt_Procedure_Type) is -- Function which returns the current count without modifying it: diff --git a/src/core/serializer/serializer.ads b/src/core/serializer/serializer.ads index e5b739c8..591a8afb 100644 --- a/src/core/serializer/serializer.ads +++ b/src/core/serializer/serializer.ads @@ -17,7 +17,7 @@ package Serializer is subtype Byte_Array is Basic_Types.Byte_Array (Byte_Array_Index); -- Note: All the subprograms below convert from a type to a byte array or a byte - -- array to a type. They perform similiarly to an unchecked conversion between the + -- array to a type. They perform similarly to an unchecked conversion between the -- two types. In terms of performance, a copy is executed when converting one type -- to another. If this is not desired, the user can use an overlay directly instead -- in their own code. You are encouraged to use the Byte_Array type, above, when diff --git a/src/core/serializer/variable_serializer.ads b/src/core/serializer/variable_serializer.ads index 0143d09e..e4bc7cf5 100644 --- a/src/core/serializer/variable_serializer.ads +++ b/src/core/serializer/variable_serializer.ads @@ -18,7 +18,7 @@ package Variable_Serializer is subtype Byte_Array is Basic_Types.Byte_Array (Byte_Array_Index); -- All the subprograms below convert from a type to a byte array or a byte - -- array to a type. They perform similiarly to an unchecked conversion between the + -- array to a type. They perform similarly to an unchecked conversion between the -- two types. In terms of performance, a copy is executed when converting one type -- to another. If this is not desired, the user can use an overlay directly instead -- in their own code. You are encouraged to use the Serialized Length function when diff --git a/src/core/serializer/variable_stream_serializer.ads b/src/core/serializer/variable_stream_serializer.ads index e051f5ee..0c3e494d 100644 --- a/src/core/serializer/variable_stream_serializer.ads +++ b/src/core/serializer/variable_stream_serializer.ads @@ -11,7 +11,7 @@ package Variable_Stream_Serializer is Max_Serialized_Length : constant Natural := T'Object_Size / Stream_Element'Object_Size; -- Serialize to and deserialize from streams. function Serialize (Stream : not null access Ada.Streams.Root_Stream_Type'Class; Input : in T) return Serialization_Status; - -- Deserialize needs to know the minimum length of the variable type (usuall the size of the header) in order to read that + -- Deserialize needs to know the minimum length of the variable type (usually the size of the header) in order to read that -- many bytes off the stream before determining how many additional bytes need to be read to deserialize the entire type. -- Passing the type's "Min_Serialized_Length" constant (found in the record autocoded ads) will suffice for this. function Deserialize (Stream : not null access Ada.Streams.Root_Stream_Type'Class; Minimum_Length : in Natural; Output : out T) return Serialization_Status; diff --git a/src/core/task/bareboard/secondary_stack_util.adb b/src/core/task/bareboard/secondary_stack_util.adb index d80d387c..37431782 100644 --- a/src/core/task/bareboard/secondary_stack_util.adb +++ b/src/core/task/bareboard/secondary_stack_util.adb @@ -1,4 +1,4 @@ --- We know that this is version dependant. We will need to update this if the +-- We know that this is version dependent. We will need to update this if the -- runtime implementation changes. pragma Warnings (Off, """System.Secondary_Stack"" is an internal GNAT unit"); pragma Warnings (Off, "use of this unit is non-portable and version-dependent"); diff --git a/src/core/task/task_synchronization.adb b/src/core/task/task_synchronization.adb index ef976f86..382beec6 100644 --- a/src/core/task/task_synchronization.adb +++ b/src/core/task/task_synchronization.adb @@ -85,7 +85,7 @@ package body Task_Synchronization is -- allows a task to poll this procedure, regardless -- of whether a task is waiting or not. if Wait'Count > 0 then - -- If we are at or over the timout limit then + -- If we are at or over the timeout limit then -- trigger a timeout condition. if Timeout_Count >= Timeout_Limit then Do_Timeout := True; diff --git a/src/core/task/task_synchronization.ads b/src/core/task/task_synchronization.ads index cf48c779..40c2aa75 100644 --- a/src/core/task/task_synchronization.ads +++ b/src/core/task/task_synchronization.ads @@ -25,7 +25,7 @@ package Task_Synchronization is -- An extension of the Wait_Release_Object above, this object provides -- the same release/wait logic but also implements a timeout. Another task, -- possibly a third task, can call "timeout" after it is deemed that a - -- timeout has occured. This will cause a waiting task to release and + -- timeout has occurred. This will cause a waiting task to release and -- the "Timed_Out" variable will be set to True. There is also a function -- which returns if a task is currently waiting or not, which can be used -- to implement more sophisticated timeout logic. @@ -68,13 +68,13 @@ package Task_Synchronization is -- timing features in regards to the timeout. It assumes three threads of -- execution. One thread "Waits" on a condition until a second thread "Releases" -- the condition. A third thread periodically calls Increment_Timeout_If_Waiting - -- which will timout the waiting thread if it has been waiting for a certain + -- which will timeout the waiting thread if it has been waiting for a certain -- number of counts. protected type Wait_Release_Timeout_Counter_Object is -- Initialize the timeout counter object with the timeout -- limit. Every time Increment_Timeout_Counter is called -- the counter will be checked against the limit. If the - -- counter >= limit then a timout condition will + -- counter >= limit then a timeout condition will -- be triggered. procedure Set_Timeout_Limit (New_Timeout_Limit : in Natural); -- Block on this entry until released by Release or Timeout. If @@ -85,8 +85,8 @@ package Task_Synchronization is procedure Release; -- Every time Increment_Timeout_If_Waiting is called -- the counter will be checked against the limit. If the - -- counter >= limit then a timout condition will - -- be triggered. A timout condition consists of + -- counter >= limit then a timeout condition will + -- be triggered. A timeout condition consists of -- Release any task blocked on Wait, but set Timed_Out to True. -- This usually needs to be called in a different task from the -- task that calls Release. diff --git a/src/data_structures/binary_tree/binary_tree.ads b/src/data_structures/binary_tree/binary_tree.ads index 251f4491..587bda5a 100644 --- a/src/data_structures/binary_tree/binary_tree.ads +++ b/src/data_structures/binary_tree/binary_tree.ads @@ -45,7 +45,7 @@ package Binary_Tree is -- Search for element in tree. This is done in O(log n) where n is the current size of the tree. -- Return: True means element was found. False means it was not. The element and index in the array where it was found are also returned. function Search (Self : in Instance; Element : in Element_Type; Element_Found : out Element_Type; Element_Index : out Positive) return Boolean; - -- Get an element via its index. This can be helpful to quickly retreive an element in O(1) time if you have already obtained its index via "search". + -- Get an element via its index. This can be helpful to quickly retrieve an element in O(1) time if you have already obtained its index via "search". function Get (Self : in Instance; Element_Index : in Positive) return Element_Type; -- Set an element via its index. This can be helpful to quickly set an element in O(1) time if you have already obtained its index via "search". procedure Set (Self : in out Instance; Element_Index : in Positive; Element : in Element_Type); diff --git a/src/data_structures/binary_tree/test/binary_tree_tests-implementation.adb b/src/data_structures/binary_tree/test/binary_tree_tests-implementation.adb index ef5fce73..cc953bdc 100644 --- a/src/data_structures/binary_tree/test/binary_tree_tests-implementation.adb +++ b/src/data_structures/binary_tree/test/binary_tree_tests-implementation.adb @@ -109,7 +109,7 @@ package body Binary_Tree_Tests.Implementation is Boolean_Assert.Eq (Self.Tree.Search (17, Tree_Element, Ignore), True); Natural_Assert.Eq (Tree_Element, 17); - -- Non existant Tree_Elements: + -- Non existent Tree_Elements: Boolean_Assert.Eq (Self.Tree.Search (2, Ignore, Ignore_Index), False); Boolean_Assert.Eq (Self.Tree.Search (11, Ignore, Ignore_Index), False); Boolean_Assert.Eq (Self.Tree.Search (27, Ignore, Ignore_Index), False); diff --git a/src/data_structures/circular_buffer/circular_buffer.adb b/src/data_structures/circular_buffer/circular_buffer.adb index 179c3d85..07184395 100644 --- a/src/data_structures/circular_buffer/circular_buffer.adb +++ b/src/data_structures/circular_buffer/circular_buffer.adb @@ -225,7 +225,7 @@ package body Circular_Buffer is pragma Assert (First_Copy_Length + Second_Copy_Length = Bytes_Length); -- Perform first copy to end of internal array: Self.Bytes (Tail .. Self.Bytes'Last) := Bytes (Bytes'First .. Bytes'First + First_Copy_Length - 1); - -- Wrap around and copy bytes at begginning of internal array: + -- Wrap around and copy bytes at beginning of internal array: Self.Bytes (Self.Bytes'First .. Self.Bytes'First + Second_Copy_Length - 1) := Bytes (Bytes'First + First_Copy_Length .. Bytes'Last); end; else @@ -236,7 +236,7 @@ package body Circular_Buffer is -- Set the and count: Self.Count := Self.Count + Bytes_Length; if Overwrite and then Self.Count > Self.Bytes'Length then - -- We need to move head if an overwrite actually occures, since we are + -- We need to move head if an overwrite actually occurs, since we are -- basically "popping" old data by doing the overwrite. Self.Head := (Self.Head + (Self.Count - Self.Bytes'Length)) mod Self.Bytes'Length; -- The count should never be greater than the length of the buffer. diff --git a/src/data_structures/circular_buffer/circular_buffer.ads b/src/data_structures/circular_buffer/circular_buffer.ads index 5d39ad18..a9e2a805 100644 --- a/src/data_structures/circular_buffer/circular_buffer.ads +++ b/src/data_structures/circular_buffer/circular_buffer.ads @@ -16,7 +16,7 @@ package Circular_Buffer is -- meta data, but no access to the internal buffer is granted the user. -- Look at inheriting packages for better data structures to use. The -- purpose of this package is solely to consolidate shared code and thus - -- ease of implementation and testing of the inherting data structures. + -- ease of implementation and testing of the inheriting data structures. type Base is tagged private; -- @@ -68,9 +68,9 @@ package Circular_Buffer is -- -- Dump functions: -- - -- These functions dump the interal circular buffer via an array of pointers. + -- These functions dump the internal circular buffer via an array of pointers. -- This array of pointers is of length 2, the second pointer accounting for - -- wrap arounds in the dump request. Sometimes the dump request can be accomodated + -- wrap arounds in the dump request. Sometimes the dump request can be accommodated -- using a single pointer, in which case the second pointer will be set to null -- with zero length: type Pointer_Dump is array (0 .. 1) of Byte_Array_Pointer.Instance; diff --git a/src/data_structures/circular_buffer/test_circular/test.adb b/src/data_structures/circular_buffer/test_circular/test.adb index d991f87c..14cdb4b4 100644 --- a/src/data_structures/circular_buffer/test_circular/test.adb +++ b/src/data_structures/circular_buffer/test_circular/test.adb @@ -398,7 +398,7 @@ procedure Test is Put_Line ("Passed."); Put_Line (""); - Put_Line ("Test more overwites."); + Put_Line ("Test more overwrites."); Data := (others => 0); Check_Meta (0); -- Lots of overwrites: diff --git a/src/data_structures/database/database.ads b/src/data_structures/database/database.ads index 63eac8ef..b7ff6ed4 100644 --- a/src/data_structures/database/database.ads +++ b/src/data_structures/database/database.ads @@ -5,7 +5,7 @@ -- -- To initialize the component 3 parameters must be passed -- 1) The maximum number of values for the database to hold --- 2) The minumum Id that the database should be able to accommodate +-- 2) The minimum Id that the database should be able to accommodate -- 3) The maximum Id that the database should be able to accommodate -- -- The data structure will allocate two tables. The first table will be as large as the value diff --git a/src/data_structures/database/variable_database.ads b/src/data_structures/database/variable_database.ads index 4f02d4c9..4a817c41 100644 --- a/src/data_structures/database/variable_database.ads +++ b/src/data_structures/database/variable_database.ads @@ -11,7 +11,7 @@ with Serializer_Types; -- 4) Serialized_Length - a function that when passed a serialized version of T will return the length of T (number of bytes) -- -- To initialize the component 3 parameters must be passed --- 1) The minumum Id that the database should be able to accommodate +-- 1) The minimum Id that the database should be able to accommodate -- 2) The maximum Id that the database should be able to accommodate -- -- The database will be sized to have entries for each possible Id between the minimum and maximum. diff --git a/src/data_structures/database/variable_test/variable_database.tests.yaml b/src/data_structures/database/variable_test/variable_database.tests.yaml index 8f1e8cac..d391e434 100644 --- a/src/data_structures/database/variable_test/variable_database.tests.yaml +++ b/src/data_structures/database/variable_test/variable_database.tests.yaml @@ -10,4 +10,4 @@ tests: - name: Test_Serialization_Failure description: This test tries to store and access data that is malformed and returns a serialization failure. - name: Test_Override - description: This test excersizes the override feature. + description: This test exercises the override feature. diff --git a/src/data_structures/database/variable_test/variable_database_tests-implementation.adb b/src/data_structures/database/variable_test/variable_database_tests-implementation.adb index 1749d8ea..be6bd3e6 100644 --- a/src/data_structures/database/variable_test/variable_database_tests-implementation.adb +++ b/src/data_structures/database/variable_test/variable_database_tests-implementation.adb @@ -224,7 +224,7 @@ package body Variable_Database_Tests.Implementation is Value.Length := Cnt; Value.Buffer := (others => Cnt); Cnt := Cnt + 1; - Put_Line ("overridding " & Natural'Image (Natural (Id)) & " => " & Simple_Variable.Representation.To_Tuple_String (Value)); + Put_Line ("overriding " & Natural'Image (Natural (Id)) & " => " & Simple_Variable.Representation.To_Tuple_String (Value)); U_Status := Self.Db.Override (Id, Value); Update_Status_Assert.Eq (U_Status, My_Database.Success); pragma Assert (Self.Db.Any_Overridden = True); diff --git a/src/data_structures/database/variable_test/variable_database_tests-implementation.ads b/src/data_structures/database/variable_test/variable_database_tests-implementation.ads index 57536389..8c3a4365 100644 --- a/src/data_structures/database/variable_test/variable_database_tests-implementation.ads +++ b/src/data_structures/database/variable_test/variable_database_tests-implementation.ads @@ -22,7 +22,7 @@ private overriding procedure Test_Data_Not_Available (Self : in out Instance); -- This test tries to store and access data that is malformed and returns a serialization failure. overriding procedure Test_Serialization_Failure (Self : in out Instance); - -- This test excersizes the override feature. + -- This test exercises the override feature. overriding procedure Test_Override (Self : in out Instance); -- Type definitions: diff --git a/src/data_structures/labeled_queue/labeled_queue.ads b/src/data_structures/labeled_queue/labeled_queue.ads index 68253b04..478f732d 100644 --- a/src/data_structures/labeled_queue/labeled_queue.ads +++ b/src/data_structures/labeled_queue/labeled_queue.ads @@ -4,7 +4,7 @@ with Ada.Synchronous_Task_Control; with Serializer_Types; -- This is a protected (thread safe) queue that supports the pushing, --- popping, and peaking of variable sized byte arrayes or typed queue +-- popping, and peaking of variable sized byte arrays or typed queue -- elements. -- -- This queue is identical to the Variable_Queue package @@ -105,7 +105,7 @@ package Labeled_Queue is -- we catch this condition and return the Error status, allowing the user to -- handle the condition as they please, usually by either moving on, or trying -- again. Proper usage of this queue in Adamant should avoid the possibility of - -- this condition ever occuring. Good design usually avoids more than one task + -- this condition ever occurring. Good design usually avoids more than one task -- simultaneously popping or pushing to the same queue in a blocking manner. Use -- the "no_wait" version of these functions above whenever possible. -- @@ -194,7 +194,7 @@ package Labeled_Queue is -- Standard pop function for statically sized packed types. Pass in the type and deserializer function to -- instantiate the generic function. Note: even if a deserialization error is encountered during the popping - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; @@ -207,7 +207,7 @@ package Labeled_Queue is -- Pop function for variable length packed types. Pass in the type, deserializer function, and a function -- which returns the serialized length of the type in order to instantiate the generic function. - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; diff --git a/src/data_structures/labeled_queue/test/test.adb b/src/data_structures/labeled_queue/test/test.adb index 7e63e715..1bd1984a 100644 --- a/src/data_structures/labeled_queue/test/test.adb +++ b/src/data_structures/labeled_queue/test/test.adb @@ -145,7 +145,7 @@ begin Natural_Assert.Eq (Len, 10); Pop_Assert.Eq (Queue.Peek_Label (Label), Success); Label_Assert.Eq (Label, Variable_Type); - -- An offset here wouldnt usually work, but in this case the values of the array make is a success. + -- An offset here wouldn't usually work, but in this case the values of the array make is a success. Pop_Type_Assert.Eq (Peek_Simple_Variable (Queue, Label, Variable_Var2, Offset => 1), Success); Label_Assert.Eq (Label, Variable_Type); Put_Line ("Peeked: " & Simple_Variable.Representation.Image (Variable_Var2)); diff --git a/src/data_structures/priority_queue/priority_queue.adb b/src/data_structures/priority_queue/priority_queue.adb index 9ee2430a..92c958d6 100644 --- a/src/data_structures/priority_queue/priority_queue.adb +++ b/src/data_structures/priority_queue/priority_queue.adb @@ -135,7 +135,7 @@ package body Priority_Queue is Elements_On_Queue : constant Natural := Self.Priority_Heap.Get_Size; begin -- Make sure the indexes make sense based on how many elements are currently - -- enqueued. This logic helps us find any FSW inconsistancies and will also + -- enqueued. This logic helps us find any FSW inconsistencies and will also -- catch bit flips. if Self.Index_Pool_Start > Self.Index_Pool_Stop then pragma Assert ((Self.Index_Pool_Start - Self.Index_Pool_Stop) = Elements_On_Queue); diff --git a/src/data_structures/protected_circular_buffer/protected_circular_buffer.ads b/src/data_structures/protected_circular_buffer/protected_circular_buffer.ads index 902a5b6e..1a25723f 100644 --- a/src/data_structures/protected_circular_buffer/protected_circular_buffer.ads +++ b/src/data_structures/protected_circular_buffer/protected_circular_buffer.ads @@ -3,7 +3,7 @@ with Basic_Types; with Serializer_Types; -- This is a protected (thread safe) buffer that supports the pushing, --- popping, and peaking of variable sized byte arrayes or typed buffer +-- popping, and peaking of variable sized byte arrays or typed buffer -- elements. package Protected_Circular_Buffer is diff --git a/src/data_structures/protected_priority_queue/protected_priority_queue.ads b/src/data_structures/protected_priority_queue/protected_priority_queue.ads index aabe2724..2d6321c2 100644 --- a/src/data_structures/protected_priority_queue/protected_priority_queue.ads +++ b/src/data_structures/protected_priority_queue/protected_priority_queue.ads @@ -85,7 +85,7 @@ package Protected_Priority_Queue is -- we catch this condition and return the Error status, allowing the user to -- handle the condition as they please, usually by either moving on, or trying -- again. Proper usage of this queue in Adamant should avoid the possibility of - -- this condition ever occuring. Good design usually avoids more than one task + -- this condition ever occurring. Good design usually avoids more than one task -- simultaneously popping or pushing to the same queue in a blocking manner. Use -- the "no_wait" version of these functions above whenever possible. -- @@ -137,7 +137,7 @@ package Protected_Priority_Queue is -- Standard pop function for statically sized packed types. Pass in the type and deserializer function to -- instantiate the generic function. Note: even if a deserialization error is encountered during the popping - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; @@ -150,7 +150,7 @@ package Protected_Priority_Queue is -- Pop function for variable length packed types. Pass in the type, deserializer function, and a function -- which returns the serialized length of the type in order to instantiate the generic function. - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; diff --git a/src/data_structures/protected_variables/protected_variables.ads b/src/data_structures/protected_variables/protected_variables.ads index 567c62ed..d3f569e1 100644 --- a/src/data_structures/protected_variables/protected_variables.ads +++ b/src/data_structures/protected_variables/protected_variables.ads @@ -66,7 +66,7 @@ package Protected_Variables is -- The user usually checks to see when the counter has reached zero, using the -- is_Count_At_Period function, and an action is performed if the returned value is true. -- These variables often need to be grouped together into a single protected object - -- to accomodate some operations that need to modify both automically in a thread + -- to accommodate some operations that need to modify both automatically in a thread -- safe manner. generic -- Any modular type diff --git a/src/data_structures/queue/queue.ads b/src/data_structures/queue/queue.ads index c5f178a0..1c60fe61 100644 --- a/src/data_structures/queue/queue.ads +++ b/src/data_structures/queue/queue.ads @@ -44,7 +44,7 @@ package Queue is -- we catch this condition and return the Error status, allowing the user to -- handle the condition as they please, usually by either moving on, or trying -- again. Proper usage of this queue in Adamant should avoid the possibility of - -- this condition ever occuring. Good design usually avoids more than one task + -- this condition ever occurring. Good design usually avoids more than one task -- simultaneously popping or pushing to the same queue in a blocking manner. Use -- the "no_wait" version of these functions above whenever possible. -- diff --git a/src/data_structures/variable_queue/test/test.adb b/src/data_structures/variable_queue/test/test.adb index b8fbcf5d..2e871e9b 100644 --- a/src/data_structures/variable_queue/test/test.adb +++ b/src/data_structures/variable_queue/test/test.adb @@ -132,7 +132,7 @@ begin Pop_Assert.Eq (Queue.Peek_Length (Len), Success); Put_Line ("len: " & Natural'Image (Len)); Natural_Assert.Eq (Len, 10); - -- An offset here wouldnt usually work, but in this case the values of the array make is a success. + -- An offset here wouldn't usually work, but in this case the values of the array make is a success. Pop_Type_Assert.Eq (Peek_Simple_Variable (Queue, Variable_Var2, Offset => 1), Success); Put_Line ("Peeked: " & Simple_Variable.Representation.Image (Variable_Var2)); Simple_Variable_Assert.Eq (Variable_Var2, (8, (8, 8, 8, 8, 8, 8, 8, 8, others => 0))); diff --git a/src/data_structures/variable_queue/variable_queue.ads b/src/data_structures/variable_queue/variable_queue.ads index 9bc542bb..fb887457 100644 --- a/src/data_structures/variable_queue/variable_queue.ads +++ b/src/data_structures/variable_queue/variable_queue.ads @@ -4,7 +4,7 @@ with Ada.Synchronous_Task_Control; with Serializer_Types; -- This is a protected (thread safe) queue that supports the pushing, --- popping, and peaking of variable sized byte arrayes or typed queue +-- popping, and peaking of variable sized byte arrays or typed queue -- elements. package Variable_Queue is @@ -92,7 +92,7 @@ package Variable_Queue is -- we catch this condition and return the Error status, allowing the user to -- handle the condition as they please, usually by either moving on, or trying -- again. Proper usage of this queue in Adamant should avoid the possibility of - -- this condition ever occuring. Good design usually avoids more than one task + -- this condition ever occurring. Good design usually avoids more than one task -- simultaneously popping or pushing to the same queue in a blocking manner. Use -- the "no_wait" version of these functions above whenever possible. -- @@ -179,7 +179,7 @@ package Variable_Queue is -- Standard pop function for statically sized packed types. Pass in the type and deserializer function to -- instantiate the generic function. Note: even if a deserialization error is encountered during the popping - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; @@ -192,7 +192,7 @@ package Variable_Queue is -- Pop function for variable length packed types. Pass in the type, deserializer function, and a function -- which returns the serialized length of the type in order to instantiate the generic function. - -- from the queue, the internal queue element is still removed from the intenal queue. So you can always count + -- from the queue, the internal queue element is still removed from the internal queue. So you can always count -- on pop to remove an element from the queue, even if an error is returned, unless of course the queue is empty. generic type T is private; diff --git a/src/types/command/invalid_command_info.record.yaml b/src/types/command/invalid_command_info.record.yaml index c94e3150..873fbb82 100644 --- a/src/types/command/invalid_command_info.record.yaml +++ b/src/types/command/invalid_command_info.record.yaml @@ -6,7 +6,7 @@ fields: type: Command_Types.Command_Id format: U16 - name: Errant_Field_Number - description: The field that was invalid. 1 is the first field, 0 means unkown field, 2**32 means that the length field of the command was invalid. + description: The field that was invalid. 1 is the first field, 0 means unknown field, 2**32 means that the length field of the command was invalid. type: Interfaces.Unsigned_32 format: U32 - name: Errant_Field diff --git a/src/types/memory/byte_array_pointer-packed.ads b/src/types/memory/byte_array_pointer-packed.ads index c6d06172..b09b51f9 100644 --- a/src/types/memory/byte_array_pointer-packed.ads +++ b/src/types/memory/byte_array_pointer-packed.ads @@ -7,7 +7,7 @@ with Memory_Region; package Byte_Array_Pointer.Packed is -- Return a packed version of this type. This is useful if you need to send - -- this pointer down in an event or something similiar. + -- this pointer down in an event or something similar. function Pack (Self : in Instance) return Memory_Region.T; -- Opposite of above function: diff --git a/src/types/memory/byte_array_pointer.ads b/src/types/memory/byte_array_pointer.ads index 617237be..8964ae4f 100644 --- a/src/types/memory/byte_array_pointer.ads +++ b/src/types/memory/byte_array_pointer.ads @@ -54,7 +54,7 @@ package Byte_Array_Pointer is function Length (Self : in Instance) return Natural with Inline => True; - -- Get address of buffer. Using "Pointer" should be preferred, excpet in rare circumstances + -- Get address of buffer. Using "Pointer" should be preferred, except in rare circumstances -- where the actual address is needed. function Address (Self : in Instance) return System.Address with Inline => True; diff --git a/src/types/parameter/invalid_parameter_info.record.yaml b/src/types/parameter/invalid_parameter_info.record.yaml index b97490e7..24230851 100644 --- a/src/types/parameter/invalid_parameter_info.record.yaml +++ b/src/types/parameter/invalid_parameter_info.record.yaml @@ -6,7 +6,7 @@ fields: type: Parameter_Types.Parameter_Id format: U16 - name: Errant_Field_Number - description: The field that was invalid. 1 is the first field, 0 means unkown field, 2**32 means that the length field of the parameter was invalid. + description: The field that was invalid. 1 is the first field, 0 means unknown field, 2**32 means that the length field of the parameter was invalid. type: Interfaces.Unsigned_32 format: U32 - name: Errant_Field diff --git a/src/types/test/test.adb b/src/types/test/test.adb index 52c3bcce..dfb6ef45 100644 --- a/src/types/test/test.adb +++ b/src/types/test/test.adb @@ -38,7 +38,7 @@ procedure Test is -- Byte array type: type Byte_Array is array (Natural range 0 .. (Serialized_Length - 1)) of Unsigned_8; - -- Function to covert packed type to byte array: + -- Function to convert packed type to byte array: function To_Byte_Array (Input : in Packed) return Byte_Array is pragma Warnings (Off, "overlay changes scalar storage order"); Result : constant Byte_Array with Import, Convention => Ada, Address => Input'Address; diff --git a/src/types/tick/tick_interrupt_handler.ads b/src/types/tick/tick_interrupt_handler.ads index 4a9d626f..627d14a1 100644 --- a/src/types/tick/tick_interrupt_handler.ads +++ b/src/types/tick/tick_interrupt_handler.ads @@ -3,7 +3,7 @@ with Tick; -- -- Because the Tick.T type is such a common type used to parameterize the the --- interrupt hanlder components (ie. the Interrupt Servicer) this package contains +-- interrupt handler components (ie. the Interrupt Servicer) this package contains -- common code used to instantiate a Tick.T based interrupt component. -- package Tick_Interrupt_Handler is diff --git a/src/unit_test/deallocation/safe_deallocator.ads b/src/unit_test/deallocation/safe_deallocator.ads index 31417f0b..64995054 100644 --- a/src/unit_test/deallocation/safe_deallocator.ads +++ b/src/unit_test/deallocation/safe_deallocator.ads @@ -23,7 +23,7 @@ package Safe_Deallocator is type Name is access Object; procedure Deallocate_If_Testing (X : in out Name); - -- Reenable warnings: + -- Re-enable warnings: pragma Warnings (On, "formal parameter ""X"" is not modified"); pragma Warnings (On, "mode could be ""in"" instead of ""in out"""); diff --git a/src/unit_test/termination_handler/unit_test_termination_handler.ads b/src/unit_test/termination_handler/unit_test_termination_handler.ads index cf9ac641..b441d7bb 100644 --- a/src/unit_test/termination_handler/unit_test_termination_handler.ads +++ b/src/unit_test/termination_handler/unit_test_termination_handler.ads @@ -14,7 +14,7 @@ package Unit_Test_Termination_Handler is -- Note: This task termination prototype will only work on a native -- platform. Ada.Task_Termination has a different package spec for - -- embedded plaforms that use Ravenscar. + -- embedded platforms that use Ravenscar. protected Task_Termination is procedure Handler (Cause : Ada.Task_Termination.Cause_Of_Termination; T : Ada.Task_Identification.Task_Id; X : Ada.Exceptions.Exception_Occurrence); end Task_Termination; diff --git a/src/util/byte_array_util/byte_array_util.adb b/src/util/byte_array_util/byte_array_util.adb index ffa2f8bd..76bd78da 100644 --- a/src/util/byte_array_util/byte_array_util.adb +++ b/src/util/byte_array_util/byte_array_util.adb @@ -167,7 +167,7 @@ package body Byte_Array_Util is -- Check the polytype value to see if it can be stored without truncation: declare - -- Calulate the limit that, if exceeded, would mean trunction would occur. + -- Calculate the limit that, if exceeded, would mean truncation would occur. Limit : constant Unsigned_32 := Shift_Right (16#FFFFFFFF#, Unsigned_32'Object_Size - Size); -- Calculate the unsigned integer value of the polytype. We do this manually to -- avoid any dependency on a packed record in this low level package. This assumes diff --git a/src/util/byte_array_util/byte_array_util.ads b/src/util/byte_array_util/byte_array_util.ads index 7a00ea5c..6f521efb 100644 --- a/src/util/byte_array_util/byte_array_util.ads +++ b/src/util/byte_array_util/byte_array_util.ads @@ -51,7 +51,7 @@ package Byte_Array_Util is -- -- The Set_Poly_Type_Status is returned from the function -- Success - The polytype was successfully stored in the destination byte array - -- Truncation_Error - If trunction is not allowed (e. Truncation_Allowed = False) then this can occur. This means + -- Truncation_Error - If truncation is not allowed (e. Truncation_Allowed = False) then this can occur. This means -- that the provided polytype value exceeds the value representable in a type with Size size in -- bytes. This means that some information will be lost during the "set" operation. If this is -- intended, then Truncation_Allowed must be set to True. In this case, Truncation_Error will diff --git a/src/util/monitor/monitor.adb b/src/util/monitor/monitor.adb index fdd34a9a..837ee010 100644 --- a/src/util/monitor/monitor.adb +++ b/src/util/monitor/monitor.adb @@ -9,7 +9,7 @@ package body Monitor is Self.State := Disabled; end if; - -- Set the persistance thresholds: + -- Set the persistence thresholds: Self.Set_Persistance_Thresholds ( Green_To_Red_Persistance_Threshold => Green_To_Red_Persistance_Threshold, Red_To_Green_Persistance_Threshold => Red_To_Green_Persistance_Threshold diff --git a/src/util/monitor/test/monitor_tests-implementation.adb b/src/util/monitor/test/monitor_tests-implementation.adb index 0941708e..f3bd53cf 100644 --- a/src/util/monitor/test/monitor_tests-implementation.adb +++ b/src/util/monitor/test/monitor_tests-implementation.adb @@ -170,7 +170,7 @@ package body Monitor_Tests.Implementation is Status_Assert.Eq (Mon.Check (False), Red); Status_Assert.Eq (Mon.Check (False), Red); - -- Set persistance thresholds: + -- Set persistence thresholds: Mon.Set_Persistance_Thresholds (Green_To_Red_Persistance_Threshold => 5, Red_To_Green_Persistance_Threshold => 1); State_Assert.Eq (Mon.Get_State, Green); diff --git a/src/util/moving_average/moving_average.adb b/src/util/moving_average/moving_average.adb index f2b7007b..f02e9c0b 100644 --- a/src/util/moving_average/moving_average.adb +++ b/src/util/moving_average/moving_average.adb @@ -14,7 +14,7 @@ package body Moving_Average is if Sample_Calculation_Size <= -1 then Self.Items_Length := Sample_Storage_Size; else - -- Assertion to make sure the desired calculation size cant be 0. Must be -1 or a number between 1 and Sample_Storage_Size. + -- Assertion to make sure the desired calculation size can't be 0. Must be -1 or a number between 1 and Sample_Storage_Size. pragma Assert (Sample_Calculation_Size > 0, "The sample calculation size must be greater than 0"); pragma Assert (Sample_Calculation_Size <= Sample_Storage_Size, "The sample calculation size must be less than the max sample size"); Self.Items_Length := Sample_Calculation_Size; @@ -59,7 +59,7 @@ package body Moving_Average is Self.Max_Value := New_Sample; end if; - -- If we loop back to the begining of the samples, then reset the max + -- If we loop back to the beginning of the samples, then reset the max if Self.Head = 0 then Self.Max_Value := New_Sample; end if; @@ -124,7 +124,7 @@ package body Moving_Average is Self.Sum_Squared := 0.0; end Reset; - -- Used to change the effective length of the running statisitics + -- Used to change the effective length of the running statistics function Change_Sample_Calculation_Size (Self : in out Instance; New_Sample_Length : in Positive) return Size_Status is begin -- Check that the requested length is not longer than the max length diff --git a/src/util/moving_average/test/moving_average.tests.yaml b/src/util/moving_average/test/moving_average.tests.yaml index 8acdffa8..b942da62 100644 --- a/src/util/moving_average/test/moving_average.tests.yaml +++ b/src/util/moving_average/test/moving_average.tests.yaml @@ -4,7 +4,7 @@ tests: - name: Test_Statistic_Values description: This unit test tests the mathmatic values that are calculated from a known set of samples - name: Test_Reset_Statistics - description: This unit test tests reseting the appropriate values in the statistics to give a new start to the moving average + description: This unit test tests resetting the appropriate values in the statistics to give a new start to the moving average - name: Test_Change_Sample_Length description: This unit test changes the length of the number of samples the moving averages is calculated over. - name: Test_Not_Initialized diff --git a/src/util/moving_average/test/moving_average_tests-implementation.adb b/src/util/moving_average/test/moving_average_tests-implementation.adb index 2412c1c9..cc7c5988 100644 --- a/src/util/moving_average/test/moving_average_tests-implementation.adb +++ b/src/util/moving_average/test/moving_average_tests-implementation.adb @@ -203,7 +203,7 @@ package body Moving_Average_Tests.Implementation is -- Run mean with no data: Ma.Calculate_Mean_Variance_Max (Ignore_Mean, Ignore_Variance, Ignore_Max); - -- Test a invalid initilization + -- Test a invalid initialization --ma.init(Sample_Storage_Size => 6, Sample_Calculation_Size => 10); pragma Unreferenced (Ma); end Test_Not_Initialized; diff --git a/src/util/moving_average/test/moving_average_tests-implementation.ads b/src/util/moving_average/test/moving_average_tests-implementation.ads index 453ef619..88c813e2 100644 --- a/src/util/moving_average/test/moving_average_tests-implementation.ads +++ b/src/util/moving_average/test/moving_average_tests-implementation.ads @@ -14,7 +14,7 @@ private -- This unit test tests the mathmatic values that are calculated from a known set of samples overriding procedure Test_Statistic_Values (Self : in out Instance); - -- This unit test tests reseting the appropriate values in the statistics to give a new start to the moving average + -- This unit test tests resetting the appropriate values in the statistics to give a new start to the moving average overriding procedure Test_Reset_Statistics (Self : in out Instance); -- This unit test changes the length of the number of samples the moving averages is calculated over. overriding procedure Test_Change_Sample_Length (Self : in out Instance); diff --git a/src/util/socket/socket.adb b/src/util/socket/socket.adb index cc2e18c3..1993fe11 100644 --- a/src/util/socket/socket.adb +++ b/src/util/socket/socket.adb @@ -59,7 +59,7 @@ package body Socket is -- Setup send channel: Channel := Stream (Sock); - -- Set the object memebers: + -- Set the object members: Self.Socket := Sock; Self.Channel := Channel; Self.Connected := True; @@ -67,7 +67,7 @@ package body Socket is when Socket_Error | Host_Error => Self.Connected := False; when E : others => - pragma Assert (False, "Unhandled exception occured while connecting to socket in " & + pragma Assert (False, "Unhandled exception occurred while connecting to socket in " & Image (Current_Task) & ASCII.LF & Exception_Name (E) & ": " & Exception_Message (E)); end Connect;