Struct System

pub struct System(/* private fields */);

The System is the top level of a system template

It defines how ECUs communicate with each other over various networks. It also contains the mapping of software components to ECUs.

Implementations

impl System

pub fn set_category( &self, category: SystemCategory, ) -> Result<(), AutosarAbstractionError>

set the category of the system

pub fn category(&self) -> Option<SystemCategory>

get the category of the system

pub fn set_pnc_vector_length( &self, length: Option<u32>, ) -> Result<(), AutosarAbstractionError>

set the pncVectorLength of the system

pub fn pnc_vector_length(&self) -> Option<u32>

get the pncVectorLength of the system

pub fn set_pnc_vector_offset( &self, offset: Option<u32>, ) -> Result<(), AutosarAbstractionError>

set the pncVectorOffset of the system

pub fn pnc_vector_offset(&self) -> Option<u32>

get the pncVectorOffset of the system

pub fn create_ecu_instance( &self, name: &str, package: &ArPackage, ) -> Result<EcuInstance, AutosarAbstractionError>

create an EcuInstance that is connected to this System

Example

let system = package1.create_system("System", SystemCategory::SystemExtract)?;
let ecu_instance = system.create_ecu_instance("ecu_name", &package2)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create the ECU-INSTANCE

pub fn ecu_instances( &self, ) -> impl Iterator<Item = EcuInstance> + Send + 'static

get an iterator over all ECU-INSTANCEs in this SYSTEM

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
system.create_ecu_instance("ecu_name1", &package)?;
system.create_ecu_instance("ecu_name2", &package)?;
for ecu in system.ecu_instances() {
    // do something
}
assert_eq!(system.ecu_instances().count(), 2);

pub fn create_can_cluster( &self, cluster_name: &str, package: &ArPackage, can_baudrate: Option<u32>, ) -> Result<CanCluster, AutosarAbstractionError>

create a new CAN-CLUSTER

The cluster must have a channel to be valid, but this channel is not created automatically. Call CanCluster::create_physical_channel to create it.

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
let cluster = system.create_can_cluster("can_cluster", &package, None)?;
cluster.create_physical_channel("can_channel");

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create the can cluster

pub fn create_ethernet_cluster( &self, cluster_name: &str, package: &ArPackage, ) -> Result<EthernetCluster, AutosarAbstractionError>

create a new ETHERNET-CLUSTER and connect it to the SYSTEM

The cluster must have at least one channel to be valid. Call EthernetCluster::create_physical_channel to create it.

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
let cluster = system.create_ethernet_cluster("ethernet_cluster", &package)?;
let vlan_info = EthernetVlanInfo { vlan_name: "VLAN_1".to_string(), vlan_id: 1};
cluster.create_physical_channel("ethernet_channel", Some(&vlan_info));

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create the ethernet cluster

pub fn create_flexray_cluster( &self, cluster_name: &str, package: &ArPackage, settings: &FlexrayClusterSettings, ) -> Result<FlexrayCluster, AutosarAbstractionError>

create a new FLEXRAY-CLUSTER and connect it to the SYSTEM

A FlexrayClusterSettings structure containing the timings and parameters for the Flexray cluster must be provided.

The cluster must have at least one channel to be valid. Call FlexrayCluster::create_physical_channel to create it.

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
let cluster = system.create_flexray_cluster("flexray_cluster", &package, &FlexrayClusterSettings::default())?;
cluster.create_physical_channel("flexray_channel", FlexrayChannelName::A);

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create the flexray cluster

pub fn clusters(&self) -> impl Iterator<Item = Cluster> + Send + 'static

Create an iterator over all clusters connected to the SYSTEM

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
system.create_can_cluster("can_cluster", &package, None)?;
system.create_flexray_cluster("flexray_cluster", &package, &FlexrayClusterSettings::default())?;
for cluster in system.clusters() {
    // do something
}
assert_eq!(system.clusters().count(), 2);

pub fn create_can_frame( &self, name: &str, package: &ArPackage, byte_length: u64, ) -> Result<CanFrame, AutosarAbstractionError>

create a new CanFrame

This new frame needs to be linked to a CanPhysicalChannel

pub fn create_flexray_frame( &self, name: &str, package: &ArPackage, byte_length: u64, ) -> Result<FlexrayFrame, AutosarAbstractionError>

create a new FlexrayFrame

This new frame needs to be linked to a FlexrayPhysicalChannel

pub fn frames(&self) -> impl Iterator<Item = Frame> + Send + 'static

iterate over all Frames in the System

This iterator returns all CAN and Flexray frames that are connected to the System using a FibexElementRef.

pub fn create_isignal( &self, name: &str, package: &ArPackage, bit_length: u64, syssignal: &SystemSignal, datatype: Option<&SwBaseType>, ) -> Result<ISignal, AutosarAbstractionError>

create a new isignal in the System

Example

let sig_package = model.get_or_create_package("/ISignals")?;
let sys_package = model.get_or_create_package("/SystemSignals")?;
let system_signal = sys_package.create_system_signal("signal1")?;
system.create_isignal("signal1", &sig_package, 32, &system_signal, None)?;

Errors

• AutosarAbstractionError::InvalidParameter sig_package and sys_package may not be identical
• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn isignals(&self) -> impl Iterator<Item = ISignal> + Send + 'static

iterate over all ISignals in the System

This iterator returns all ISignals that are connected to the System using a FibexElementRef.

pub fn create_isignal_group( &self, name: &str, package: &ArPackage, system_signal_group: &SystemSignalGroup, ) -> Result<ISignalGroup, AutosarAbstractionError>

create a new signal group in the System

I-SIGNAL-GROUP and SYSTEM-SIGNAL-GROUP are created using the same name; therefore they must be placed in different packages: sig_package and sys_package may not be identical.

Example

let sig_package = model.get_or_create_package("/ISignals")?;
let sys_package = model.get_or_create_package("/SystemSignals")?;
let system_signal_group = sys_package.create_system_signal_group("signalgroup")?;
system.create_isignal_group("signal_group", &sig_package, &system_signal_group)?;

Errors

• AutosarAbstractionError::InvalidParameter sig_package and sys_package may not be identical
• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn isignal_groups( &self, ) -> impl Iterator<Item = ISignalGroup> + Send + 'static

iterate over all ISignalGroups in the System

This iterator returns all ISignalGroups that are connected to the System using a FibexElementRef.

pub fn create_isignal_ipdu( &self, name: &str, package: &ArPackage, length: u32, ) -> Result<ISignalIPdu, AutosarAbstractionError>

create an ISignalIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_isignal_ipdu("pdu", &package, 42)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_nm_pdu( &self, name: &str, package: &ArPackage, length: u32, ) -> Result<NmPdu, AutosarAbstractionError>

create an NmPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_nm_pdu("pdu", &package, 42)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_n_pdu( &self, name: &str, package: &ArPackage, length: u32, ) -> Result<NPdu, AutosarAbstractionError>

create an NPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_n_pdu("pdu", &package, 42)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_dcm_ipdu( &self, name: &str, package: &ArPackage, length: u32, ) -> Result<DcmIPdu, AutosarAbstractionError>

create a DcmIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_dcm_ipdu("pdu", &package, 42)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_general_purpose_pdu( &self, name: &str, package: &ArPackage, length: u32, category: GeneralPurposePduCategory, ) -> Result<GeneralPurposePdu, AutosarAbstractionError>

create a GeneralPurposePdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_general_purpose_pdu("pdu", &package, 42, GeneralPurposePduCategory::GlobalTime)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_general_purpose_ipdu( &self, name: &str, package: &ArPackage, length: u32, category: GeneralPurposeIPduCategory, ) -> Result<GeneralPurposeIPdu, AutosarAbstractionError>

create a GeneralPurposeIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_general_purpose_ipdu("pdu", &package, 42, GeneralPurposeIPduCategory::Xcp)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_container_ipdu( &self, name: &str, package: &ArPackage, length: u32, header_type: ContainerIPduHeaderType, rx_accept: RxAcceptContainedIPdu, ) -> Result<ContainerIPdu, AutosarAbstractionError>

create a ContainerIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_container_ipdu("pdu", &package, 42, ContainerIPduHeaderType::ShortHeader, RxAcceptContainedIPdu::AcceptAll)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_secured_ipdu( &self, name: &str, package: &ArPackage, length: u32, secure_props: &SecureCommunicationProps, ) -> Result<SecuredIPdu, AutosarAbstractionError>

create a SecuredIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
let secure_communication_props = SecureCommunicationProps::default();
system.create_secured_ipdu("pdu", &package, 42, &secure_communication_props)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn create_multiplexed_ipdu( &self, name: &str, package: &ArPackage, length: u32, ) -> Result<MultiplexedIPdu, AutosarAbstractionError>

create a MultiplexedIPdu in the System

Example

let package = model.get_or_create_package("/Pdus")?;
system.create_multiplexed_ipdu("pdu", &package, 42)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model while trying to create elements

pub fn pdus(&self) -> impl Iterator<Item = Pdu> + Send + 'static

iterate over all PDUs in the System

This iterator returns all PDUs that are connected to the System using a FibexElementRef.

pub fn create_socket_connection_ipdu_identifier_set( &self, name: &str, package: &ArPackage, ) -> Result<SocketConnectionIpduIdentifierSet, AutosarAbstractionError>

Create a SocketConnectionIpduIdentifierSet in the SYSTEM

SocketConnectionIpduIdentifierSet are part of the new ethernet modeling that was introduced in Autosar 4.5.0 (AUTOSAR_00048).

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
let set = system.create_socket_connection_ipdu_identifier_set("set", &package)?;

pub fn create_so_ad_routing_group( &self, name: &str, package: &ArPackage, control_type: Option<EventGroupControlType>, ) -> Result<SoAdRoutingGroup, AutosarAbstractionError>

Create a SoAdRoutingGroup in the SYSTEM

SoAdRoutingGroup are part of the old ethernet modeling that was used prior to Autosar 4.5.0 (AUTOSAR_00048). The elements are still present (but obsolete) in newer versions of the standard. Old and new elements may not be mixed in the same model.

pub fn create_service_instance_collection_set( &self, name: &str, package: &ArPackage, ) -> Result<ServiceInstanceCollectionSet, AutosarAbstractionError>

Create a ServiceInstanceCollectionSet in the SYSTEM

ServiceInstanceCollectionSets are part of the new ethernet modeling that was introduced in Autosar 4.5.0 (AUTOSAR_00048).

pub fn create_someip_tp_config<T: Into<Cluster> + Clone>( &self, name: &str, package: &ArPackage, cluster: &T, ) -> Result<SomeipTpConfig, AutosarAbstractionError>

Create a SomeipTpConfig in the SYSTEM

SomeipTpConfigs contain the configuration how to segment or reassemble large SomeipTp PDUs.

pub fn create_can_tp_config( &self, name: &str, package: &ArPackage, can_cluster: &CanCluster, ) -> Result<CanTpConfig, AutosarAbstractionError>

Create a CanTpConfig in the SYSTEM

CanTpConfigs contain the configuration how to segment or reassemble diagnostic messages on a CAN bus.

pub fn create_doip_tp_config( &self, name: &str, package: &ArPackage, eth_cluster: &EthernetCluster, ) -> Result<DoIpTpConfig, AutosarAbstractionError>

Create a DoIpTpConfig in the SYSTEM

DoIpTpConfigs contain the configuration how to transmit diagnostic messages over IP networks.

pub fn create_flexray_tp_config( &self, name: &str, package: &ArPackage, flexray_cluster: &FlexrayCluster, ) -> Result<FlexrayTpConfig, AutosarAbstractionError>

Create a FlexRayTpConfig in the SYSTEM

FlexRayTpConfigs describe how to segment or reassemble diagnostic messages on a FlexRay bus. This configuration type is used for Flexray ISO TP communication.

pub fn create_flexray_ar_tp_config( &self, name: &str, package: &ArPackage, flexray_cluster: &FlexrayCluster, ) -> Result<FlexrayArTpConfig, AutosarAbstractionError>

Create a FlexrayArTpConfig in the SYSTEM

FlexrayArTpConfigs describe how to segment or reassemble diagnostic messages on a FlexRay bus. This configuration type is used for Flexray AUTOSAR TP communication.

pub fn create_nm_config( &self, name: &str, package: &ArPackage, ) -> Result<NmConfig, AutosarAbstractionError>

Create a new NmConfig in the SYSTEM

NmConfigs contain the configuration for network management. The System may contain zero or one NmConfigs.

pub fn nm_config(&self) -> Option<NmConfig>

Get the NmConfig of the SYSTEM, if any

The System may contain zero or one NmConfigs.

pub fn create_fibex_element_ref( &self, elem: &Element, ) -> Result<(), AutosarAbstractionError>

connect an element to the SYSTEM by creating a FIBEX-ELEMENT-REF

If there is already a FIBEX-ELEMENT-REF, this function does nothing, successfully.

Example

let system = package.create_system("System", SystemCategory::SystemExtract)?;
let can_cluster = pkg_elements.create_named_sub_element(ElementName::CanCluster, "Cluster")?;
system.create_fibex_element_ref(&can_cluster)?;

Errors

• AutosarAbstractionError::ModelError An error occurred in the Autosar model

pub fn set_root_sw_composition( &self, name: &str, composition_type: &CompositionSwComponentType, ) -> Result<RootSwCompositionPrototype, AutosarAbstractionError>

set the root software composition of the system

When the root software composition is set, a root sw composition prototype is created for it. This function will remove any existing root sw composition prototype

pub fn root_sw_composition(&self) -> Option<RootSwCompositionPrototype>

get the root software composition of the system

pub fn get_or_create_mapping( &self, name: &str, ) -> Result<SystemMapping, AutosarAbstractionError>

get or create a mapping for this system

There does not seem to be any benefit to having multiple mappings for a single system, so this function will return the first mapping if it exists. Otherwise a new mapping will be created with the provided name.

Trait Implementations

impl AbstractionElement for System

fn element(&self) -> &Element

Get the underlying Element from the abstraction element

impl Clone for System

fn clone(&self) -> System

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for System

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<System> for Element

fn from(val: System) -> Self

Converts to this type from the input type.

impl Hash for System

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IdentifiableAbstractionElement for System

fn name(&self) -> Option<String>

Get the item name of the element

fn set_name(&self, name: &str) -> Result<(), AutosarAbstractionError>

Set the item name of the element

impl PartialEq for System

fn eq(&self, other: &System) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Element> for System

type Error = AutosarAbstractionError

The type returned in the event of a conversion error.

fn try_from(element: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for System

impl StructuralPartialEq for System