ros2/openvehicle-api
3
0
Fork 0
mirror of https://github.com/eclipse-openvehicle-api/openvehicle-api.git synced 2026-04-21 11:38:16 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update sdv_packager (#6)

Browse Source
This commit is contained in:
tompzf
2026-03-27 14:12:49 +01:00
committed by GitHub
parent 234be8917f
commit aefefd52f7
717 changed files with 42252 additions and 11334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
sdv_executables/sdv_vss_util/vss_vd_generator.h
View File

@@ -1,3 +1,16 @@
/********************************************************************************
* Copyright (c) 2025-2026 ZF Friedrichshafen AG
*
* This program and the accompanying materials are made available under the
* terms of the Apache License Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0
*
* SPDX-License-Identifier: Apache-2.0
*
* Contributors:
* Thomas Pfleiderer - initial API and implementation
********************************************************************************/
#ifndef VSS_VD_GENERATOR_H
#define VSS_VD_GENERATOR_H
@@ -36,74 +49,109 @@ public:
private:
/**
* @brief create content of the summary tect file
* @return string containing the complete content of the summary text file;
*/
* @brief create content of the summary tect file
* @return string containing the complete content of the summary text file;
*/
std::string SummaryTextFile() const;
/**
* @brief create a file name including prefix and extension
* @param[in] prefix
* @param[in] filename
* @param[in] extension
* @return combined file name
*/
* @brief create a file name including prefix and extension
* @param[in] prefix
* @param[in] filename
* @param[in] extension
* @return combined file name
*/
std::string AppendExtension(const std::string& prefix, const std::string& filename, const std::string& extension) const;
/**
* @brief create vehicle device and basic service .h an .cpp files
* create IDL files
* @param[in] ssVersion optional information will be placed in the header of the files
*/
* @brief create vehicle device and basic service .h an .cpp files
* create IDL files
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateFiles(const std::string& ssVersion);
/**
* @brief create IDL files and vehicle device and basic service files of RX signals
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateRXFiles(const std::string& ssVersion) const;
* @brief create IDL files and vehicle device and basic service files of RX signals
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateRXFiles(const std::string& ssVersion);
/**
* @brief create vehicle device files of a single RX signal
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateVehicleDeviceFilesForRXSignal(const SSignalVDDefinition& signal, const std::string& ssVersion) const;
* @brief create vehicle device files of a single RX signal
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateVehicleDeviceFilesForRXSignal(const SSignalVDDefinition& signal, const std::string& ssVersion);
/**
* @brief create IDL file of a single RX signal (vehicle device)
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
* @brief create IDL file of a single RX signal (vehicle device)
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateIDLVehicleDeviceFileForRXSignal(const SSignalVDDefinition& signal, const std::string& ssVersion) const;
/**
* @brief create IDL files and vehicle device and basic service files of TX signals
* @param[in] ssVersion optional information will be placed in the header of the files
*/
* @brief create IDL files and vehicle device and basic service files of TX signals
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateTXFiles(const std::string& ssVersion) const;
/**
* @brief create vehicle device files of a single TX signal
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
* @brief create vehicle device files of a single TX signal
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateVehicleDeviceFilesForTXSignal(const SSignalVDDefinition& signal, const std::string& ssVersion) const;
/**
* @brief create IDL file for a single TX signal (vehicle device)
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
* @brief create IDL file for a single TX signal (vehicle device)
* @param[in] signal single signal definition
* @param[in] ssVersion optional information will be placed in the header of the files
*/
void CreateIDLVehicleDeviceFileForTXSignal(const SSignalVDDefinition& signal, const std::string& ssVersion) const;
bool m_enableComponentCreation; ///< if set, the code for the components are created, otherwise only idl files
std::string m_ssPrefix; ///< prefix, used by cmake library and signal definition in signal_identifier.h file.
std::string m_ssVersion; ///< optional version tag, will be wriiten in header of the files
std::filesystem::path m_pathProject; ///< Project file path
std::vector <SSignalVDDefinition> m_signals; ///< all signals
std::vector <SSignalVDDefinition> m_TXsignals; ///< vector containing the RX signals
std::vector <SSignalVDDefinition> m_RXsignals; ///< vector containing the TX signals
/**
* @brief In case a RX signal and TX signal have the same vss name we need to update the existing rx signal files
* @param[in] rootPath complete root path
* @param[in] subfolder subfolder of the rx signal files
* @return true if files could be updated successfully, otherwise false
*/
bool UpdateExistingFiles(const std::filesystem::path& rootPath, const std::string& subfolder, const SSignalVDDefinition& signal) const;
/**
* @brief Update existing cpp file of a rx signal
* @param[in] rootPath complete root path
* @param[in] signal single signal definition
* @param[in] initializeList list of interfaces for the initialization method
* @param[in] implementation function implementation methods
* @return true if file could be updated successfully, otherwise false
*/
bool UpdateCppFile(const std::filesystem::path& rootFolder, const SSignalVDDefinition& signal, const std::string& initializeList, const std::string& implementation) const;
/**
* @brief Update existing cpp file of a rx signal
* @param[in] rootPath complete root path
* @param[in] signal single signal definition
* @param[in] includeList list of headers to be included
* @param[in] interfaceList list if interfaces
* @param[in] interfaceEntryList list of event entry interfaces
* @param[in] functionList list of function definitions
* @param[in] variablePointerList list of interface pointers
* @return true if file could be updated successfully, otherwise false
*/
bool UpdateHeaderFile(const std::filesystem::path& rootFolder, const SSignalVDDefinition& signal, const std::string& includeList,
const std::string& interfaceList, const std::string& interfaceEntryList, const std::string& functionList, const std::string& variablePointerList) const;
bool m_enableComponentCreation; ///< if set, the code for the components are created, otherwise only idl files
std::string m_ssPrefix; ///< prefix, used by cmake library and signal definition in signal_identifier.h file.
std::string m_ssVersion; ///< optional version tag, will be written in header of the files
std::filesystem::path m_pathProject; ///< Project file path
std::vector <SSignalVDDefinition> m_signals; ///< all signals
std::vector <SSignalVDDefinition> m_TXsignals; ///< vector containing the RX signals
std::vector <SSignalVDDefinition> m_RXsignals; ///< vector containing the TX signals
std::vector<std::filesystem::path> m_createdFiles; ///< collect all files created when the RX signals are processed
};
#endif // !defined VSS_VD_GENERATOR_H