Class CVSSCodingCommon#

Inheritance Relationships#

Base Types#

Class Documentation#

class CVSSCodingCommon : public CCodeGeneratorBase, private CVSSHelper#

VSS code generator coding class. Creates the code out of templates.

Public Functions

inline CVSSCodingCommon(const std::string &rsPrefix)#

Constructor.

Parameters:

rsPrefix – [in] used by cmake library and signal definition in signal_identifier.h file

void GetCommonKeyWordMap(const SSignalVDDefinition &signal, CKeywordMap &mapKeywords, const std::string &rsVersion) const#

fill the KeyWordMap with all required strings

Parameters:

  • signal – [in] signal definition structure to fill the KeyWordMap

  • mapKeywords – [in] KeyWordMap to be filled

  • rsVersion – [in] optional information will be placed in the header of the files

void GetCommonKeyWordMap(const SSignalBSDefinition &signal, CKeywordMap &mapKeywords, const std::string &rsVersion) const#

fill the KeyWordMap with all required strings

Parameters:

  • signal – [in] signal definition structure to fill the KeyWordMap

  • mapKeywords – [in] KeyWordMap to be filled

  • rsVersion – [in] optional information will be placed in the header of the files

std::string Code_SignalIdentifier(const std::vector<SSignalVDDefinition> &allSignals, const std::string &ssFileName, const std::string &ssVersion) const#

create content of the signal_identifier.h file

Parameters:

  • allSignals – [in] container of all signal definitions

  • ssFileName – [in] file name of the signal_identifier.h file

  • ssVersion – [in] optional information will be placed in the header of the files

Returns:

content of the signal_identifier.h file

std::string Code_VSSFileVersion(const std::string &ssVersion) const#

get the version line which will be added in the header of the files

Parameters:

ssVersion – [in] optional information will be placed in the header of the files

Returns:

line for the header of the files to know the file is auto generated

std::string Code_SafeGuard(const std::string &ssFileName) const#

generates the unique define to avoid duplicate loading of a header file

Parameters:

ssFileName – [in] file name which will be included in the unique define

Returns:

unique define string

std::string Code_CMakeProject(const std::string &targetLibName, const std::string &targetComponentName) const#

generates the cmakelist.txt file

Parameters:

  • targetLibName – [in] project cmake name

  • targetComponentName – [in] is the name of the header and cpp file

Returns:

content of the CMakeList.txt file

Protected Functions

std::string Code_SignalIdentifierList(const std::vector<SSignalVDDefinition> &allSignals, const SSignalVDDefinition &signal, const SFunctionVDDefinition &func, const std::string &signalTitle, const std::string &canSignalTitle, const std::string &cTypeTitle) const#

create a signal line for the signal_identifier file

Parameters:

  • allSignals – [in] container of all signals for aligning of the string

  • signal – [in] single signal the function belongs to

  • func – [in] the function which should be returned in a line

  • signalTitle – [in] signal title string in file signal_identifier.h

  • canSignalTitle – [in] can signal title string in file signal_identifier.h

  • cTypeTitle – [in] c-type title string in file signal_identifier.h

Returns:

content of a single function for the signal_identifier file

std::string Code_AllSignalsIdentifierList(const std::vector<SSignalVDDefinition> &allSignals, const std::string &signalTitle, const std::string &canSignalTitle, const std::string &cTypeTitle) const#

create a list of all signals for the signal_identifier file

Parameters:

  • allSignals – [in] container of all signals

  • signalTitle – [in] signal title string in file signal_identifier.h

  • canSignalTitle – [in] can signal title string in file signal_identifier.h

  • cTypeTitle – [in] c-type title string in file signal_identifier.h

Returns:

content of list of all signals for the signal_identifier file

Protected Attributes

std::string m_ssPrefix#

prefix, used by cmake library and signal definition in signal_identifier.h file.