AUTOSAR_EXP_ARAComAPI的5章笔记（1）

5.1 High Level API Structure

ara::com提供了一个支持AUTOSAR服务模型 的API。服务有Method、Event、Filed 和Trigger。

Method :在服务应用程序中执行一个可以返回值的函数(如校准方法)。
Event :当特定条件发生时(例如制动事件)，服务应用程序发送一个事件(也可能包括一个值)。客户端应用程序可以订阅事件。
Filed :在任何时候都有一个值，比如状态值。可以使用Get读取或使用Set修改(例如，UpdateRate )。当Filed值 改变时，可以通知客户端应用程序。
Trigger :当特定条件发生时，服务应用程序 发送一个触发器。客户端应用程序可以订阅触发器。

如4.1节所述，客户端和服务应用程序相互通信，因此API支持双方的Method 、Event 和Field 。这意味着API定义了发送和接收事件的接口，提供和调用服务方法，为Field 的setter和getter注册处理程序等等。 ara::com API还定义了ctors/dtor来创建和销毁Proxy Class 和Skeleton Class 的实例。最后，ara::com API还提供了提供/查找服务和订阅/取消订阅事件的方法。

5.2 API Elements

接下来的章节将会介绍ara::com定义的不同API元素。由于我们将给出各种工件的代码示例，并从开发人员的角度提供如何使用这些API的示例代码，因此在我们的示例中保持某种一致性是一个好主意。所以我们会使用一个叫做"RadarService "的虚拟服务(接口)。以下是一种半正式 的描述，它让您对这个"RadarService"(服务接口)提供/做什么有一个印象，并且可能比正式的AutoSar Arxml 服务描述更容易阅读:

RadarService 的定义如下：

md-end-block 复制代码

RadarService 
{
	 // types used within service
	 type RadarObjects 
	 {
		 active : bool
		 objects : array 
		 {
			 elementtype: uint8
			 size: variable
		 }
	 }

	 type Position 
	 {
		 x: uint32
		 y: uint32
		 z: uint32
	 }

	 // events provided by service
	 event BrakeEvent 
	 {
		type:RadarObjects
	 }

	 // fields provided by service
	 field UpdateRate 
	 {
		 type:uint32
		 get: true
		 set: true
	 }

	 error CalibrationFailed 
	 {
		 errorCode : 1
		 errorContext 
		 {
			failureText : string
		 }
	 }

	 error InvalidConfigString 
	 {
		 errorCode : 2
		 errorContext 
		 {
			 invalidConfig : string
			 currentValidConfig : string
		 }
	 }

	 // methods provided by service
	 method Calibrate
	 {
		param configuration 
		{
			type: string
			direction: in
		}
		param result 
		{
			type: bool
			direction: out
		}
		raises 
		{
			CalibrationFailed
			InvalidConfigString
		}
	}

	 method Adjust 
	 {
		 param target_position 
		 {
			type: Position
			direction: in
		 }
		 param success 
		 {
			type: bool
			direction: out
		 }
		 param effective_position 
		 {
			type: Position
			direction: out
		 }
	 }

	oneway method LogCurrentState {}
 }

因此，示例服务RadarService提供了一个Event: "BrakeEvent "，它由一个包含标志和uint8的可变长度数组 结构组成。然后它提供了一个Fileld :"UpdateRate ",它是uint32类型，支持get 和set 调用，最后RadarService又提供了如下三个方法：

方法"Adjust "，用于定位雷达，它包含一个目标位置作为输入参数 和两个输出参数（一个表示定位成功，一个(可能偏离)有效位置）。
方法"Calibrate "，用于校准雷达，获得一个配置字符串作为输入参数 ，并返回一个成功指示符 作为输出参数。如果校准失败，此方法可能会引发两种不同的应用程序错误:"校准失败 "和"无效配置字符串"。
"LogCurrentState "方法是一种单向方法，这意味着如果该方法被执行，则不会向调用者返回任何反馈。它指示服务RadarService将其当前状态输出到其本地日志文件中。AUTOSAR_EXP_ARAComAPI的3章节笔记