Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.5 KB

apigear.md

File metadata and controls

42 lines (30 loc) · 2.5 KB
Raw

Vspec ApiGear exporter

Generates a solution and a module file. All signals and types are added to a single module. This is due to the current architecture of ApiGear.

ApiGear does not allow constructing multiple modules. Each module is generated as a separate submodule in a solution. This means, if we create multiple modules and use unreal template, it will generate as many plugins, as there are modules. Furthermore, ApiGear does not support importing modules within other modules - thus, cannot create a module substructure, which would be useful to define a type / signal structure. Therefore, we have to use the naming within a single module to recreate the VSS substructure.

To simplify the running the generator, ApiGear exporter creates a solution file. This lets developer run a single command to generate all specified templates:

apigear generate solution <solution-file>

Exporter generates solution templates with basic features, API and implementation skeletons (stubs). In case of UE or Qt they allow technical designers to start their work already in chosen technology. For C++ it adds functionality for subscribing for any changes in the interface state. See ApiGear documentation for other futures e.g. enabling connectivity or simulation - they require other libraries to be installed (depending on technology, most of them will be installed automatically).

--output-dir

Required output directory for the solution and module files.

--apigear-template-unreal-path

Add Unreal layer to solution file at the specified path, uses the ApiGear apigear-io/template-unreal template. Relative path relates to the --output-dir.

--apigear-template-cpp-path

Add Cpp14 layer to solution file at the specified path, uses the ApiGear apigear-io/template-cpp14 template. Relative path relates to the --output-dir.

--apigear-template-qt5-path

Add Qt5 layer to solution file at the specified path, uses the ApiGear apigear-io/template-qt5 template. Relative path relates to the --output-dir.

--apigear-template-qt6-path

Add Qt6 layer to solution file at the specified path, uses the ApiGear apigear-io/template-qtcpp template. Relative path relates to the --output-dir.

Example usage

vspec --log-level DEBUG export apigear \
--output-dir ./solution \
--apigear-template-unreal-path ./unreal \
--apigear-template-cpp-path ./cpp14 \
--apigear-template-qt5-path ./qt5 \
--apigear-template-qt6-path ./qt6 \
-u ./spec/units.yaml \
-s ./spec/VehicleSignalSpecification.vspec