ADTF_DEVICE_TOOLBOX  3.12.1 (ADTF 3.18.3)
can_database_intf.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <string.h>
11 #include <adtf_utils.h>
12 #include <adtf_ucom3.h>
13 #include "can_types.h"
14 
18 #define CID_DEVTB_CANDB_PARSER "can_database_parser.service.devicetb.cid"
19 
20 
24 namespace adtf
25 {
26 
30 namespace devicetb
31 {
32 
36 namespace sdk
37 {
38 
42 namespace can
43 {
44 
48 namespace axle
49 {
53 class ICANDatabase : public adtf::ucom::ant::IObject
54 {
55 public:
56  ADTF_IID(ICANDatabase, "can_database.axle.can.sdk.devicetb.adtf.iid");
57 
58 public:
65  virtual tResult GetMessageCount(uint32_t* pnMessageCount) const = 0;
66 
75  virtual tResult GetMessageID(const char* strMessageName, tMessageID* pnMessageID, bool* pbExtended) const = 0;
76 
85  virtual tResult GetMessageName(tMessageID nMessageID, bool bExtended, const char** pMessageName) const = 0;
86 
95  virtual tResult GetMessageInfo(tMessageID nMessageID, bool bExtended, const tMessageInfo** pMessageInfo) const = 0;
96 
103  virtual tResult GetSignalCount(uint32_t* pnSignalCount) const = 0;
104 
112  virtual tResult GetSignalID(const char* strSignalName, tSignalID* pnSignalID) const = 0;
113 
121  virtual tResult GetSignalName(tSignalID nSignalID, const char** pSignalName) const = 0;
122 
130  virtual tResult GetSignalUnit(tSignalID nSignalID, const char** pSignalUnit) const = 0;
131 
139  virtual tResult GetSignalDescription(tSignalID nSignalID, const char** pSignalDescription) const = 0;
140 
148  virtual tResult GetSignalInfo(tSignalID nSignalID, const tSignalInfo** pSignalInfo) const = 0;
149 
158  virtual tResult GetNetworkNodes(std::vector<const char*>& astrNetworkNodes) const = 0;
159 
167  virtual tResult GetNetworkNames(std::vector<const char*>& astrNetworkNames) const = 0;
168 };
169 
173 class ICANDatabaseList: public adtf::ucom::ant::IObject
174 {
175  public:
176  ADTF_IID(ICANDatabaseList, "can_database_list.axle.can.sdk.devicetb.adtf.iid");
177 
182  {
183  public:
189  virtual tResult HandleMessage(const tMessageInfo* pInfo) = 0;
190  };
191 
197  virtual tResult ListCANMessages(IMessageCallback* pCallback) const = 0;
198 };
199 
200 } //namespace axle
201 
204 
205 } //namespace can
206 } //namespace sdk
207 } // namespace devicetb
208 } // namespace adtf
Copyright 2024 CARIAD SE.
virtual tResult GetMessageID(const char *strMessageName, tMessageID *pnMessageID, bool *pbExtended) const =0
Retrieves the ID of a Message.
virtual tResult GetSignalUnit(tSignalID nSignalID, const char **pSignalUnit) const =0
Returns the unito of a signal.
virtual tResult GetMessageCount(uint32_t *pnMessageCount) const =0
Returns the count of Messages described in this DBC.
virtual tResult GetNetworkNames(std::vector< const char * > &astrNetworkNames) const =0
Returns an array of names of all CAN networks.
virtual tResult GetSignalName(tSignalID nSignalID, const char **pSignalName) const =0
Returns the name of a signal.
virtual tResult GetMessageName(tMessageID nMessageID, bool bExtended, const char **pMessageName) const =0
Retrieves the name of a Message.
virtual tResult GetSignalInfo(tSignalID nSignalID, const tSignalInfo **pSignalInfo) const =0
Returns information about a signal.
virtual tResult GetSignalDescription(tSignalID nSignalID, const char **pSignalDescription) const =0
Returns the description of a signal.
virtual tResult GetMessageInfo(tMessageID nMessageID, bool bExtended, const tMessageInfo **pMessageInfo) const =0
Returns the information structure for the specified message.
virtual tResult GetNetworkNodes(std::vector< const char * > &astrNetworkNodes) const =0
Returns an array of names of all network nodes.
virtual tResult GetSignalCount(uint32_t *pnSignalCount) const =0
Returns the count of signals described in this database.
virtual tResult GetSignalID(const char *strSignalName, tSignalID *pnSignalID) const =0
Returns the ID of a signal.
virtual tResult HandleMessage(const tMessageInfo *pInfo)=0
This method will be called for each CAN message.
Interface of a CAN database for retrieving all available CAN messages.
virtual tResult ListCANMessages(IMessageCallback *pCallback) const =0
This will call the callback for each available CAN message.
axle::ICANDatabase ICANDatabase
The ICANDatabase interface.
axle::ICANDatabaseList ICANDatabaseList
Interface of a CAN database for retrieving all available CAN messages.
ADTF - Namespace.