QCanDbcFileParser Class

QCanDbcFileParser fileParser;
const bool result = fileParser.parse(u"path/to/file.dbc"_s);
// Check result, call error() and warnings() if needed

// Prepare a QCanFrameProcessor to decode or encode DBC frames
QCanFrameProcessor frameProcessor;
frameProcessor.setUniqueIdDescription(QCanDbcFileParser::uniqueIdDescription());
frameProcessor.setMessageDescriptions(fileParser.messageDescriptions());

Member Function Documentation

QCanDbcFileParser::QCanDbcFileParser()

Constructs a DBC file parser.

QCanDbcFileParser::~QCanDbcFileParser()

Destroys this DBC file parser.

QCanDbcFileParser::Error QCanDbcFileParser::error() const

Returns the last error which occurred during the parsing.

See also errorString() and parse().

QString QCanDbcFileParser::errorString() const

Returns the text representation of the last error which occurred during the parsing or an empty string if there was no error.

See also error().

QList<QCanMessageDescription> QCanDbcFileParser::messageDescriptions() const

Returns the list of message descriptions that were extracted during the last parse() call.

See also parse() and error().

QCanDbcFileParser::MessageValueDescriptions QCanDbcFileParser::messageValueDescriptions() const

Returns the textual descriptions for signal raw values.

DBC supports the possibility to provide textual descriptions to signal raw values. If such data exists in the parsed DBC file(s), it can be accessed using this function.

The textual descriptions are unique for a certain signal within a specific message, so the returned structure contains the information about the message unique id and the signal name, as well as the actual value descriptions.

See also QCanDbcFileParser::MessageValueDescriptions, QCanDbcFileParser::SignalValueDescriptions, and QCanDbcFileParser::ValueDescriptions.

bool QCanDbcFileParser::parse(const QString &fileName)

Parses the file fileName. Returns true if the parsing completed successfully or false otherwise.

If the parsing completed successfully, call the messageDescriptions() method to get the list of all extracted message descriptions.

If the parsing failed, call the error() and errorString() methods to get the information about the error.

Call the warnings() method to get the list of warnings that were logged during the parsing.

See also messageDescriptions(), error(), and warnings().

bool QCanDbcFileParser::parse(const QStringList &fileNames)

This is an overloaded function.

Parses a list of files fileNames. Returns true if the parsing completed successfully or false otherwise.

If the parsing completed successfully, call the messageDescriptions() method to get the list of all extracted message descriptions.

The parsing stops at the first error. Call the error() and errorString() methods to get the information about the error.

Call the warnings() method to get the list of warnings that were logged during the parsing.

See also messageDescriptions(), error(), and warnings().

[static] QCanUniqueIdDescription QCanDbcFileParser::uniqueIdDescription()

Returns a unique identifier description. DBC protocol always uses the Frame Id as an identifier, and therefore the unique identifier description is always the same.

Use this method to get an instance of QCanUniqueIdDescription and pass it to QCanFrameProcessor.

See also QCanFrameProcessor::setUniqueIdDescription().

QStringList QCanDbcFileParser::warnings() const

Returns the list of non-critical problems which occurred during the parsing.

A typical problem can be a malformed message or signal description. In such cases the malformed message or signal is skipped, but the rest of the file can be processed as usual.

See also error() and parse().