Skip to content

Commit 67283de

Browse files
aregtecharegtech
authored
36 update service interface documents in demo (#37)
* Update documents. * Update areg-sdk submodul * fixed demo 17 project
1 parent 89e2633 commit 67283de

25 files changed

+325
-378
lines changed

‎demo/10_locsvc/services/HelloWorld.siml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2-
<ServiceInterface FormatVersion="1.0.0">
3-
<Overview ID="1" Name="HelloWorld" Version="1.0.1">
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<ServiceInterface FormatVersion="1.1.0">
3+
<Overview ID="1" Name="HelloWorld" Version="1.1.0" Category="Private">
44
<Description>Simple Service Interface to demonstrate working features of AREG SDK.</Description>
55
</Overview>
66
<MethodList>
7-
<Method ID="7" MethodType="request" Name="HelloWorld" Response="HelloWorld">
7+
<Method ID="7" Name="HelloWorld" MethodType="Request" Response="HelloWorld">
88
<Description>Request to print hello world</Description>
99
<ParamList>
10-
<Parameter DataType="String" ID="8" Name="roleName">
10+
<Parameter ID="51" Name="roleName" DataType="String">
1111
<Description>The role name of client component that requested to print hello world</Description>
1212
</Parameter>
1313
</ParamList>
1414
</Method>
15-
<Method ID="10" MethodType="response" Name="HelloWorld">
15+
<Method ID="10" Name="HelloWorld" MethodType="Response">
1616
<Description>The response to hello world request.</Description>
1717
</Method>
18-
<Method ID="14" MethodType="request" Name="ShutdownService">
18+
<Method ID="14" Name="ShutdownService" MethodType="Request">
1919
<Description>Sent by client to request to shutdown service and the application. This request has no response.</Description>
2020
</Method>
21-
<Method ID="15" MethodType="broadcast" Name="ReachedMaximum">
21+
<Method ID="15" Name="ReachedMaximum" MethodType="Broadcast">
2222
<Description>Triggered to notify that reached the maximum number of requests.</Description>
2323
<ParamList>
24-
<Parameter DataType="int32" ID="19" Name="maxNumber">
24+
<Parameter ID="52" Name="maxNumber" DataType="int32">
2525
<Description>The maximum number of requests.</Description>
2626
</Parameter>
2727
</ParamList>
2828
</Method>
2929
</MethodList>
3030
<ConstantList>
31-
<Constant DataType="int16" ID="18" Name="MaxMessages">
31+
<Constant ID="18" Name="MaxMessages" DataType="int16">
3232
<Value>37</Value>
3333
<Description>The maximum number of messages to output.</Description>
3434
</Constant>
3535
</ConstantList>
36-
</ServiceInterface>
36+
</ServiceInterface>

‎demo/12_pubsvc/services/HelloWorld.siml‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,63 @@
1-
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2-
<ServiceInterface FormatVersion="1.0.0">
3-
<Overview ID="1" Name="HelloWorld" Version="1.0.2" isRemote="true">
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<ServiceInterface FormatVersion="1.1.0">
3+
<Overview ID="1" Name="HelloWorld" Version="1.1.0" Category="Public">
44
<Description>Simple Service Interface to demonstrate working features of AREG SDK.</Description>
55
</Overview>
66
<DataTypeList>
77
<DataType ID="2" Name="sConnectedClient" Type="Structure">
88
<Description>The dummy structure describing connected client.</Description>
99
<FieldList>
10-
<Field DataType="uint32" ID="3" Name="ccID">
10+
<Field ID="3" Name="ccID" DataType="uint32">
1111
<Value IsDefault="true">0</Value>
1212
<Description>The ID of client, given by servicing component</Description>
1313
</Field>
14-
<Field DataType="String" ID="4" Name="ccName">
15-
<Value IsDefault="true"/>
14+
<Field ID="4" Name="ccName" DataType="String">
1615
<Description>The role name of client component. Parameter received by client.</Description>
1716
</Field>
1817
</FieldList>
1918
</DataType>
2019
</DataTypeList>
2120
<MethodList>
22-
<Method ID="7" MethodType="request" Name="HelloWorld" Response="HelloWorld">
21+
<Method ID="7" Name="HelloWorld" MethodType="Request" Response="HelloWorld">
2322
<Description>Request to print hello world</Description>
2423
<ParamList>
25-
<Parameter DataType="String" ID="8" Name="roleName">
24+
<Parameter ID="51" Name="roleName" DataType="String">
2625
<Description>The role name of client component that requested to print hello world</Description>
2726
</Parameter>
2827
</ParamList>
2928
</Method>
30-
<Method ID="10" MethodType="response" Name="HelloWorld">
29+
<Method ID="10" Name="HelloWorld" MethodType="Response">
3130
<Description>The response to hello world request.</Description>
3231
<ParamList>
33-
<Parameter DataType="sConnectedClient" ID="11" Name="clientInfo">
32+
<Parameter ID="52" Name="clientInfo" DataType="sConnectedClient">
3433
<Description>The client information set by servicing component. If empty or invalid ID, the message output failed.</Description>
3534
</Parameter>
3635
</ParamList>
3736
</Method>
38-
<Method ID="14" MethodType="request" Name="ShutdownService">
37+
<Method ID="14" Name="ShutdownService" MethodType="Request">
3938
<Description>Sent by client to request to shutdown service and the application. This request has no response.</Description>
4039
<ParamList>
41-
<Parameter DataType="uint32" ID="16" Name="clientID">
40+
<Parameter ID="53" Name="clientID" DataType="uint32">
4241
<Description>The ID of client that requests to shutdown. The ID is given by service when first time client requests to output message.</Description>
4342
</Parameter>
44-
<Parameter DataType="String" ID="17" Name="roleName">
43+
<Parameter ID="54" Name="roleName" DataType="String">
4544
<Description>Service client component role name</Description>
4645
</Parameter>
4746
</ParamList>
4847
</Method>
49-
<Method ID="15" MethodType="broadcast" Name="ReachedMaximum">
48+
<Method ID="15" Name="ReachedMaximum" MethodType="Broadcast">
5049
<Description>Triggered to notify that reached the maximum number of requests.</Description>
5150
<ParamList>
52-
<Parameter DataType="int32" ID="19" Name="maxNumber">
51+
<Parameter ID="55" Name="maxNumber" DataType="int32">
5352
<Description>The maximum number of requests.</Description>
5453
</Parameter>
5554
</ParamList>
5655
</Method>
5756
</MethodList>
5857
<ConstantList>
59-
<Constant DataType="int16" ID="18" Name="MaxMessages">
58+
<Constant ID="18" Name="MaxMessages" DataType="int16">
6059
<Value>100</Value>
6160
<Description>The maximum number of messages to output.</Description>
6261
</Constant>
6362
</ConstantList>
64-
</ServiceInterface>
63+
</ServiceInterface>

‎demo/16_pubfsm/services/PowerManager.siml‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,58 @@
1-
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2-
<ServiceInterface FormatVersion="1.0.0">
3-
<Overview ID="1" Name="PowerManager" Version="1.0.0">
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<ServiceInterface FormatVersion="1.1.0">
3+
<Overview ID="1" Name="PowerManager" Version="1.1.0" Category="Private">
44
<Description>This is a power manager of Traffic Light Controller. It powers the lights ON and OFF.</Description>
55
</Overview>
66
<DataTypeList>
7-
<DataType ID="3" Name="ePoweredState" Type="Enumerate" Values="default">
7+
<DataType ID="3" Name="ePoweredState" Type="Enumeration" Values="default">
88
<Description>The power state of the traffic lights.</Description>
99
<FieldList>
1010
<EnumEntry ID="4" Name="LightsOFF">
11-
<Value/>
1211
<Description>The lights are OFF</Description>
1312
</EnumEntry>
1413
<EnumEntry ID="5" Name="LightsON">
15-
<Value/>
1614
<Description>The lights are ON.</Description>
1715
</EnumEntry>
1816
</FieldList>
1917
</DataType>
2018
</DataTypeList>
2119
<AttributeList>
22-
<Attribute DataType="ePoweredState" ID="6" Name="LightsPowerState" Notify="OnChange">
20+
<Attribute ID="6" Name="LightsPowerState" DataType="ePoweredState" Notify="OnChange">
2321
<Description>The power state of the traffic lights.</Description>
2422
</Attribute>
2523
</AttributeList>
2624
<MethodList>
27-
<Method ID="2" MethodType="request" Name="PowerOn">
25+
<Method ID="2" Name="PowerOn" MethodType="Request">
2826
<Description>Called to power ON the traffic lights.</Description>
2927
</Method>
30-
<Method ID="7" MethodType="request" Name="PowerOff">
28+
<Method ID="7" Name="PowerOff" MethodType="Request">
3129
<Description>Called to power OFF the traffic lights.</Description>
3230
</Method>
33-
<Method ID="8" MethodType="request" Name="StartTrafficLight" Response="StartTrafficLight">
31+
<Method ID="8" Name="StartTrafficLight" MethodType="Request" Response="StartTrafficLight">
3432
<Description>Triggered to start the traffic light</Description>
3533
</Method>
36-
<Method ID="9" MethodType="response" Name="StartTrafficLight">
34+
<Method ID="9" Name="StartTrafficLight" MethodType="Response">
3735
<Description>Sent as a response to start the traffic light. The traffic light can be started when it is powered ON and in initialization state.</Description>
3836
<ParamList>
39-
<Parameter DataType="bool" ID="10" Name="Success">
37+
<Parameter ID="51" Name="Success" DataType="bool">
4038
<Description>Flag, indicating whether the operation succeeded or not.
4139
This flag is 'true' if lights are initialization state of if traffic light is already functioning.
4240
This flag is 'false' if lights are OFF.</Description>
4341
</Parameter>
4442
</ParamList>
4543
</Method>
46-
<Method ID="11" MethodType="request" Name="StopTrafficLight" Response="StopTrafficLight">
44+
<Method ID="11" Name="StopTrafficLight" MethodType="Request" Response="StopTrafficLight">
4745
<Description>Call to stop the traffic lights and put them in initialization state.</Description>
4846
</Method>
49-
<Method ID="12" MethodType="response" Name="StopTrafficLight">
47+
<Method ID="12" Name="StopTrafficLight" MethodType="Response">
5048
<Description>Response to stop the traffic lights.</Description>
5149
<ParamList>
52-
<Parameter DataType="bool" ID="13" Name="Success">
50+
<Parameter ID="52" Name="Success" DataType="bool">
5351
<Description>Flag, indicating whether the request was processed with success or not.
5452
This flag is 'true' if traffic light are functioning or lights are in initialization state.
5553
This flag is 'false' if traffic lights are OFF.</Description>
5654
</Parameter>
5755
</ParamList>
5856
</Method>
5957
</MethodList>
60-
</ServiceInterface>
58+
</ServiceInterface>

‎demo/16_pubfsm/services/TrafficController.siml‎

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,105 @@
1-
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2-
<ServiceInterface FormatVersion="1.0.0">
3-
<Overview ID="1" Name="TrafficController" Version="1.0.0" isRemote="true">
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<ServiceInterface FormatVersion="1.1.0">
3+
<Overview ID="1" Name="TrafficController" Version="1.1.0" Category="Public">
44
<Description>This is a traffic light controlle service interface.</Description>
55
</Overview>
66
<DataTypeList>
7-
<DataType ID="2" Name="eTrafficDirection" Type="Enumerate" Values="default">
7+
<DataType ID="2" Name="eTrafficDirection" Type="Enumeration" Values="default">
88
<Description>The direction of traffic.</Description>
99
<FieldList>
1010
<EnumEntry ID="4" Name="DirectionUndefiend">
11-
<Value/>
1211
<Description>Undefined direction.</Description>
1312
</EnumEntry>
1413
<EnumEntry ID="5" Name="DirectionSouthNorth">
15-
<Value/>
1614
<Description>The traffic direction is south-north.</Description>
1715
</EnumEntry>
1816
<EnumEntry ID="6" Name="DirectionEastWest">
19-
<Value/>
2017
<Description>The traffic direction is east-west.</Description>
2118
</EnumEntry>
2219
</FieldList>
2320
</DataType>
24-
<DataType ID="7" Name="eVehicleTrafficLight" Type="Enumerate" Values="default">
21+
<DataType ID="7" Name="eVehicleTrafficLight" Type="Enumeration" Values="default">
2522
<Description>The states of vehicle traffic states.</Description>
2623
<FieldList>
2724
<EnumEntry ID="8" Name="VehicleLightOFF">
28-
<Value/>
2925
<Description>The vehicle lights are OFF.</Description>
3026
</EnumEntry>
3127
<EnumEntry ID="9" Name="VehicleLightsInit">
32-
<Value/>
3328
<Description>The vehicle lights are initialized (blink yellow).</Description>
3429
</EnumEntry>
3530
<EnumEntry ID="10" Name="VehicleLightRed">
36-
<Value/>
3731
<Description>Vehicle light is red.</Description>
3832
</EnumEntry>
3933
<EnumEntry ID="11" Name="VehicleLightYellow">
40-
<Value/>
4134
<Description>Vehicle light is yellow.</Description>
4235
</EnumEntry>
4336
<EnumEntry ID="12" Name="VehicleLightGreen">
44-
<Value/>
4537
<Description>The vehicle light is green.</Description>
4638
</EnumEntry>
4739
</FieldList>
4840
</DataType>
49-
<DataType ID="13" Name="ePedestrianTrafficLight" Type="Enumerate" Values="default">
41+
<DataType ID="13" Name="ePedestrianTrafficLight" Type="Enumeration" Values="default">
5042
<Description>The traffic light state of pedestrians.</Description>
5143
<FieldList>
5244
<EnumEntry ID="14" Name="PedestrianLightOFF">
53-
<Value/>
5445
<Description>The pedestrian light is OFF.</Description>
5546
</EnumEntry>
5647
<EnumEntry ID="15" Name="PedestrianLightRed">
57-
<Value/>
5848
<Description>Pedestrian light is red.</Description>
5949
</EnumEntry>
6050
<EnumEntry ID="16" Name="PedestrianLightGreen">
61-
<Value/>
6251
<Description>The pedestrian light is green.</Description>
6352
</EnumEntry>
6453
</FieldList>
6554
</DataType>
6655
<DataType ID="28" Name="sTrafficLight" Type="Structure">
6756
<Description>Describes the direction of traffic and the states of lights for vehicle and pedestrians.</Description>
6857
<FieldList>
69-
<Field DataType="eTrafficDirection" ID="29" Name="trafficDirection">
58+
<Field ID="29" Name="trafficDirection" DataType="eTrafficDirection">
7059
<Value IsDefault="true">eTrafficDirection::DirectionUndefiend</Value>
7160
<Description>The traffic direction</Description>
7261
</Field>
73-
<Field DataType="eVehicleTrafficLight" ID="30" Name="lightVehicle">
62+
<Field ID="30" Name="lightVehicle" DataType="eVehicleTrafficLight">
7463
<Value IsDefault="true">eVehicleTrafficLight::VehicleLightOFF</Value>
7564
<Description>The state of vehicle lights.</Description>
7665
</Field>
77-
<Field DataType="ePedestrianTrafficLight" ID="31" Name="lightPedestrian">
66+
<Field ID="31" Name="lightPedestrian" DataType="ePedestrianTrafficLight">
7867
<Value IsDefault="true">ePedestrianTrafficLight::PedestrianLightOFF</Value>
7968
<Description>Describes the state of pedestrian lights.</Description>
8069
</Field>
8170
</FieldList>
8271
</DataType>
8372
</DataTypeList>
8473
<AttributeList>
85-
<Attribute DataType="sTrafficLight" ID="32" Name="TrafficSouthNorth" Notify="OnChange">
74+
<Attribute ID="32" Name="TrafficSouthNorth" DataType="sTrafficLight" Notify="OnChange">
8675
<Description>The south-north traffic.</Description>
8776
</Attribute>
88-
<Attribute DataType="sTrafficLight" ID="33" Name="TrafficEastWest" Notify="OnChange">
77+
<Attribute ID="33" Name="TrafficEastWest" DataType="sTrafficLight" Notify="OnChange">
8978
<Description>The east-west traffic</Description>
9079
</Attribute>
9180
</AttributeList>
9281
<MethodList>
93-
<Method ID="21" MethodType="broadcast" Name="SouthNorth">
82+
<Method ID="21" Name="SouthNorth" MethodType="Broadcast">
9483
<Description>Broadcasts the light states of south-north direction.</Description>
9584
<ParamList>
96-
<Parameter DataType="eVehicleTrafficLight" ID="23" Name="LightVehicle">
85+
<Parameter ID="51" Name="LightVehicle" DataType="eVehicleTrafficLight">
9786
<Description>Light state for vehicles</Description>
9887
</Parameter>
99-
<Parameter DataType="ePedestrianTrafficLight" ID="24" Name="LightPedestrian">
88+
<Parameter ID="52" Name="LightPedestrian" DataType="ePedestrianTrafficLight">
10089
<Description>Light state for pedestrians.</Description>
10190
</Parameter>
10291
</ParamList>
10392
</Method>
104-
<Method ID="25" MethodType="broadcast" Name="EastWest">
93+
<Method ID="25" Name="EastWest" MethodType="Broadcast">
10594
<Description>Broadcasts the light states of east-west direction.</Description>
10695
<ParamList>
107-
<Parameter DataType="eVehicleTrafficLight" ID="26" Name="LightVehicle">
96+
<Parameter ID="53" Name="LightVehicle" DataType="eVehicleTrafficLight">
10897
<Description>Light state for vehicles</Description>
10998
</Parameter>
110-
<Parameter DataType="ePedestrianTrafficLight" ID="27" Name="LightPedestrian">
99+
<Parameter ID="54" Name="LightPedestrian" DataType="ePedestrianTrafficLight">
111100
<Description>Light state for pedestrians.</Description>
112101
</Parameter>
113102
</ParamList>
114103
</Method>
115104
</MethodList>
116-
</ServiceInterface>
105+
</ServiceInterface>

‎demo/17_winchat/17_chatter.vcxproj‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
<Import Project="$(AregConfigDir)project.props" Label="LocalAppDataPlatform" />
2222
</ImportGroup>
2323
<PropertyGroup Label="UserMacros" />
24+
<PropertyGroup Label="Vcpkg">
25+
<VcpkgEnabled>false</VcpkgEnabled>
26+
</PropertyGroup>
2427
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
2528
<ClCompile>
2629
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>

‎demo/17_winchat/17_generated.vcxproj‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
<PropertyGroup>
2424
<OutDir>$(OutLibDir)</OutDir>
2525
</PropertyGroup>
26+
<PropertyGroup Label="Vcpkg">
27+
<VcpkgEnabled>false</VcpkgEnabled>
28+
</PropertyGroup>
2629
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
2730
<ClCompile>
2831
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS;%(PreprocessorDefinitions)</PreprocessorDefinitions>

‎demo/17_winchat/17_register.vcxproj‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
<Import Project="$(AregConfigDir)project.props" Label="LocalAppDataPlatform" />
2222
</ImportGroup>
2323
<PropertyGroup Label="UserMacros" />
24+
<PropertyGroup Label="Vcpkg">
25+
<VcpkgEnabled>false</VcpkgEnabled>
26+
</PropertyGroup>
2427
<ItemDefinitionGroup Condition="'$(ConfigShortName)'=='Debug'">
2528
<ClCompile>
2629
<PreprocessorDefinitions>IMPORT_SHARED_SYMBOLS=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>

0 commit comments

Comments
 (0)