Skip to content

Commit b27155e

Browse files
committed
Update README
- Add list of convenience methods - Add repo-local links
1 parent 895e1d7 commit b27155e

File tree

2 files changed

+124
-44
lines changed

2 files changed

+124
-44
lines changed

README.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Methods in the simple API:
130130
* Workspace.find_element
131131
* Workspace.get_package
132132

133-
For for more information, see the `Simple API - User Guide` that demonstrates the use of this API.
133+
For for more information, see the [Simple API - User Guide](doc/markdown/simple_api_user_guide.md) that demonstrates the use of this API.
134134

135135
#### Advanced API - Requires namespaces
136136

@@ -145,7 +145,7 @@ Methods in the advanced API:
145145

146146
It can be quite powerful when used the right way but requires some setting up.
147147

148-
There's no user guide yet. See the files under `examples/template` for reference.
148+
There's no user guide yet. See the files under [examples/template](examples/template/) for reference.
149149

150150
#### Common methods
151151

@@ -163,11 +163,41 @@ Common methods:
163163

164164
The module `autosar.xml.element` contains all supported elements that you can add to a package. Most often you simply call the constructor for an object you want to create and then add it to a package.
165165

166-
Some elements are quite complicated to create manually. Instead of using the constructor these classes offers one or several convenience-methods in the form of static methods with names beginning with `make_` or `create_`. These methods returns an object much the same way as calling a constructor.
166+
Some elements are quite complicated to create manually. Instead of using the constructor method, some classes offers one or several convenience-methods with names
167+
beginning with either `make_` or `create_`. Exploring these methods is highly recomended.
167168

168169
List of convenience-methods:
169170

170-
* TBD
171+
* `MultiLanguageOverviewParagraph.make`
172+
* `Computation.make_value_table`
173+
* `Computation.make_rational`
174+
* `DataConstraint.make_physical`
175+
* `DataConstraint.make_internal`
176+
* `ValueSpecification.make_value_with_check`
177+
* `ValueSpecification.make_value`
178+
* `ConstantSpecification.make_constant`
179+
* `ModeDeclarationGroup.create_mode_declaration`
180+
* `SenderReceiverInterface.create_data_element`
181+
* `SenderReceiverInterface.create_invalidation_policy`
182+
* `NvDataInterface.create_data_element`
183+
* `ParameterInterface.create_parameter`
184+
* `ClientServerOperation.create_argument`
185+
* `ClientServerOperation.create_in_argument`
186+
* `ClientServerOperation.create_inout_argument`
187+
* `ClientServerOperation.create_out_argument`
188+
* `ClientServerOperation.create_possible_error_ref`
189+
* `ClientServerInterface.create_operation`
190+
* `ClientServerInterface.create_possible_error`
191+
* `ModeSwitchInterface.create_mode_group`
192+
* `ProvidePortComSpec.make_from_port_interface`
193+
* `ProvidePortComSpec.make_non_queued_sender_com_spec`
194+
* `ProvidePortComSpec.make_from_port_interface`
195+
* `RequirePortComSpec.make_non_queued_receiver_com_spec`
196+
* `SwComponentType.create_provide_port`
197+
* `SwComponentType.create_require_port`
198+
* `SwComponentType.create_pr_port`
199+
* `CompositionSwComponentType.create_component_prototype`
200+
* `CompositionSwComponentType.create_connector`
171201

172202
## Python Module Hierachy
173203

0 commit comments

Comments
 (0)