DatabaseCAN

Summary

Represents a CAN Database object.

See also

ISignalEcu

Database

Methods: DatabaseCAN.get_all_clusters()

DatabaseCAN.get_all_ecus()

DatabaseCAN.get_all_frame_triggerings()

DatabaseCAN.get_all_frames()

DatabaseCAN.get_ecu_by_id()

DatabaseCAN.get_ecu_by_name()

DatabaseCAN.get_frame_by_id()

DatabaseCAN.get_frame_description()

DatabaseCAN.get_path()

DatabaseCAN.get_signal_by_name()

DatabaseCAN.get_signals_by_frame()

DatabaseCAN.get_tp_configs()

DatabaseCAN.get_unit_by_signal()

Structure

class DatabaseCAN

get_all_clusters() → List[ICluster]

Gets all the Clusters of the database and returns them in a list.

Returns: A list of all the Clusters in the database.
Return type: List[ICluster]

get_all_ecus() → List[ISignalEcu]

Gets all the ECUs of the database and returns them in a list.

Returns: List of all the ECUs in the database.
Return type: List[ISignalEcu]

get_all_ecus() → List[ISignalEcu]

Gets all the ISignalEcus of the database and returns them in a list.

Returns: A list of all the ISignalEcus in the database.
Return type: List[ISignalEcu]

get_all_frame_triggerings() → List[IFrameTriggering]

Gets all the Frame Triggerings of the database and returns them in a list.

Returns: List of all the Frame Triggerings in the database.
Return type: List[IFrameTriggering]

get_all_frames() → List[IFrameInstance]

Gets all the Frames of the database and returns them in a list.

Returns: List of all the Frames in the database.
Return type: List[IFrameInstance]

get_ecu_by_id(id: str) → ISignalEcu

Identifies an ECU by its Id from the ECUs of the database and returns it.

Parameters: id (str) – The Id of the ECU to identify
Returns: The ECU identified
Return type: ISignalEcu

get_ecu_by_name(name: str) → ISignalEcu

Identifies an ECU by its name from the ECUs of the database and returns it.

Parameters: name (str) – The name of the ECU to be identified
Returns: The ECU identified
Return type: ISignalEcu

get_frame_by_id(frame_id: uint32, ecu_name: str = None, cluster_name: str = None) → IFrameInstance

Identified a frame by its id from all the frames of the database and returns it.

Parameters

frame_id (uint32) – The id of the frame to be identified
ecu_name (str) – The name of the frame's parent ECU
cluster_name (str) – The name of the frame's parent Cluster

Returns

The identified frame

Return type

IFrameInstance

get_frame_description(frame_id: uint32) → str

Identifies a frame by its id and returns its description.

Parameters: frame_id (uint32) – The Id of the frame to be identified.
Returns: Description of the frame identified.
Return type: str

get_path() → str

Gets the path of the database.

Returns: The path of the database
Return type: str

get_signal_by_name(name: str) → ISignalInstance

Identifies a signal by its name from all the signals of the database and returns it.

Parameters: name (str) – The name of the signal
Returns: The signal identified
Return type: ISignalInstance

get_signals_by_frame(frame_id: uint32) → List[ISignalInstance]

Identifies a frame by its id and returns all the signals of that frame.

Parameters: frame_id (uint32) – The id of the frame to be identified
Returns: List of the signals
Return type: List[ISignalInstance]

get_tp_configs() → List[ITpConfig]

Gets all the Configurations of the used transport protocol from the database and returns them in a list.

Returns: List of all the Configurations of the used transport protocol in the database.
Return type: List[ITpConfig]

get_unit_by_signal(frame_id: uint32, signal_name: str) → Unit

Identifies a unit by its signal and returns it.

Parameters

frame_id (uint32) – The id of the frame that contains the signal needed.
signal_name (str) – The name of the signal.

Returns

The Unit identified

Return type

Unit