Skip to content

Commit b67586d

Browse files
ssingh2099FScholPer
authored andcommitted
Add component description for Containers library.
1 parent 79ff5f6 commit b67586d

File tree

1 file changed

+37
-0
lines changed
  • docs/modules/baselibs/containers/docs

1 file changed

+37
-0
lines changed

docs/modules/baselibs/containers/docs/index.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,44 @@
1515
containers
1616
##########
1717

18+
.. document:: Containers Library
19+
:id: doc__containers
20+
:status: draft
21+
:safety: ASIL_B
22+
:tags: baselibs_containers
23+
:realizes: PROCESS_wp__cmpt_request
24+
1825
.. toctree::
1926
:hidden:
2027

2128
requirements/index.rst
29+
30+
Abstract
31+
========
32+
33+
This component request proposes the integration of a safe Containers library for common data structures like dynamic arrays and linked lists.
34+
35+
Motivation and Rationale
36+
========================
37+
38+
The Containers library shall provide safe and efficient implementations of common data structures, such as dynamic arrays and linked lists.
39+
Containers library shall enable developers to manage collections of data in a type-safe manner, reducing the risk of runtime errors and improving code quality.
40+
A Containers library with type-safe data structures is needed in the S-CORE software platform due to the frequent use of collections in various features and the need for reliable data management.
41+
There are multiple use-cases like managing lists of sensor readings, storing configuration parameters, or handling dynamic data sets.
42+
43+
Specification
44+
=============
45+
46+
The following details and requirements describe the aspects of the current feature in the context of S-CORE.
47+
48+
General considerations
49+
----------------------
50+
51+
The Containers library should provide type-safe data structures and efficient memory management capabilities:
52+
53+
* :need:`comp_req__containers__dynamic_array`
54+
* :need:`comp_req__containers__intrusive_list`
55+
* :need:`comp_req__containers__type_safety`
56+
* :need:`comp_req__containers__deterministic_behavior`
57+
58+
The component should be extensible in the future to support additional data structures and algorithms as needed.

0 commit comments

Comments
 (0)